TGUI  1.4.0
Loading...
Searching...
No Matches

Message box widget. More...

#include <TGUI/Widgets/MessageBox.hpp>

Inheritance diagram for tgui::MessageBox:
tgui::ChildWindow tgui::Container tgui::Widget

Public Types

using Ptr = std::shared_ptr<MessageBox>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const MessageBox>
 Shared constant widget pointer.
 
using Alignment = HorizontalAlignment
 The label and button alignment.
 
- Public Types inherited from tgui::ChildWindow
enum  TitleButton : unsigned int { None = 0 , Close = 1 << 0 , Maximize = 1 << 1 , Minimize = 1 << 2 }
 Title buttons (use bitwise OR to combine) More...
 
using Ptr = std::shared_ptr<ChildWindow>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const ChildWindow>
 Shared constant widget pointer.
 
using TitleAlignment = HorizontalAlignment
 Title alignments, possible options for the setTitleAlignment function.
 
- 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

 MessageBox (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
 MessageBox (const MessageBox &copy)
 Copy constructor.
 
 MessageBox (MessageBox &&copy) noexcept
 Move constructor.
 
MessageBoxoperator= (const MessageBox &right)
 Overload of copy assignment operator.
 
MessageBoxoperator= (MessageBox &&right) noexcept
 Overload of move assignment operator.
 
TGUI_NODISCARD MessageBoxRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const MessageBoxRenderergetSharedRenderer () const override
 
TGUI_NODISCARD MessageBoxRenderergetRenderer () 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 message box.
 
void setClientSize (const Layout2d &size) override
 Changes the client size of the child window.
 
void setText (const String &text)
 Changes the text of the message box.
 
TGUI_NODISCARD const StringgetText () const
 Returns the text of the message box.
 
void addButton (const String &buttonCaption)
 Adds a button to the message box.
 
void changeButtons (const std::vector< String > &buttonCaptions)
 Adds, removes, or updates buttons from the message box.
 
TGUI_NODISCARD std::vector< StringgetButtons () const
 Returns the caption of the buttons.
 
void setLabelAlignment (HorizontalAlignment labelAlignment)
 Changes where the label is located inside the window (left side, centered or right side)
 
TGUI_NODISCARD HorizontalAlignment getLabelAlignment () const
 Returns where the label is located inside the window (left side, centered or right side)
 
void setButtonAlignment (HorizontalAlignment buttonAlignment)
 Changes where the buttons are located inside the window (left side, centered or right side)
 
TGUI_NODISCARD HorizontalAlignment getButtonAlignment () const
 Returns where the buttons are located inside the window (left side, centered or right side)
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::ChildWindow
 ChildWindow (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
 ChildWindow (const ChildWindow &)
 Copy constructor.
 
 ChildWindow (ChildWindow &&) noexcept
 Move constructor.
 
ChildWindowoperator= (const ChildWindow &)
 Overload of copy assignment operator.
 
ChildWindowoperator= (ChildWindow &&) noexcept
 Overload of move assignment operator.
 
void setPosition (const Layout2d &position) override
 Sets the position of the widget.
 
TGUI_NODISCARD Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container.
 
TGUI_NODISCARD Vector2f getClientSize () const
 Returns the client size of the child window.
 
void setMaximumSize (Vector2f size)
 Sets the maximum size of the child window.
 
TGUI_NODISCARD Vector2f getMaximumSize () const
 Returns the maximum size of the child window.
 
void setMinimumSize (Vector2f size)
 Sets the minimum size of the child window.
 
TGUI_NODISCARD Vector2f getMinimumSize () const
 Returns the minimum size of the child window.
 
void setTitle (const String &title)
 Changes the title that is displayed in the title bar of the child window.
 
TGUI_NODISCARD const StringgetTitle () const
 Returns the title that is displayed in the title bar of the child window.
 
void setTitleTextSize (unsigned int size)
 Changes the character size of the title.
 
TGUI_NODISCARD unsigned int getTitleTextSize () const
 Returns the character size of the title.
 
void setTitleAlignment (HorizontalAlignment alignment)
 Changes the title alignment.
 
TGUI_NODISCARD HorizontalAlignment getTitleAlignment () const
 Returns the title alignment.
 
void setTitleButtons (unsigned int buttons)
 Changes the title buttons.
 
TGUI_NODISCARD unsigned int getTitleButtons () const
 Returns the title bar buttons.
 
void close ()
 Try to close the window.
 
void destroy ()
 Closes the window.
 
void setResizable (bool resizable=true)
 Changes whether the child window can be resized by dragging its borders or not.
 
TGUI_NODISCARD bool isResizable () const
 Checks whether the child window can be resized by dragging its borders or not.
 
void setPositionLocked (bool positionLocked=true)
 Changes whether the child window can be moved by dragging its title bar or not.
 
TGUI_NODISCARD bool isPositionLocked () const
 Checks whether the child window can be moved by dragging its title bar or not.
 
void setKeepInParent (bool enabled=true)
 Sets the child window to be kept inside its parent.
 
TGUI_NODISCARD bool isKeptInParent () const
 Tells whether the child window is kept inside its parent.
 
TGUI_NODISCARD bool getKeepInParent () const
 Returns whether the child window is kept inside its parent.
 
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).
 
void setParent (Container *parent) override
 
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 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 mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target.
 
void setPosition (Layout x, Layout y)
 Sets the position 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 () 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.
 
virtual TGUI_NODISCARD Widget::Ptr getWidgetAtPos (Vector2f pos, bool recursive) const
 Returns the 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)
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
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
 
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
 
void rightMouseButtonNoLongerDown () override
 
TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos) override
 
bool updateTime (Duration elapsedTime) 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.
 
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)
 Sets how the position is determined compared to the other widgets in the parent.
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 Returns how the position is determined compared to the other widgets in the parent.
 
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 setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
TGUI_NODISCARD bool getIgnoreMouseEvents () const
 Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
 
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 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 MessageBox::Ptr create (const String &title="", const String &text="", const std::vector< String > &buttons={})
 Creates a new message box widget.
 
static TGUI_NODISCARD MessageBox::Ptr copy (const MessageBox::ConstPtr &messageBox)
 Makes a copy of another message box.
 
- Static Public Member Functions inherited from tgui::ChildWindow
static TGUI_NODISCARD ChildWindow::Ptr create (const String &title="", unsigned int titleButtons=TitleButton::Close)
 Creates a new child window widget.
 
static TGUI_NODISCARD ChildWindow::Ptr copy (const ChildWindow::ConstPtr &childWindow)
 Makes a copy of another child window.
 

Public Attributes

SignalString onButtonPress = {"ButtonPressed"}
 One of the buttons was pressed. Optional parameter: text of the pressed button.
 
- Public Attributes inherited from tgui::ChildWindow
Signal onMousePress = {"MousePressed"}
 The mouse went down on the widget.
 
SignalChildWindow onClose = {"Closed"}
 The window was closed. Optional parameter: pointer to the window.
 
SignalChildWindow onMinimize = {"Minimized"}
 The window was minimized. Optional parameter: pointer to the window.
 
SignalChildWindow onMaximize = {"Maximized"}
 The window was maximized. Optional parameter: pointer to the window.
 
SignalChildWindow onEscapeKeyPress = {"EscapeKeyPressed"}
 The escape key was pressed while the child window was focused. Optional parameter: pointer to the window.
 
SignalTyped< bool * > onClosing = {"Closing"}
 
- 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 [] = "MessageBox"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::ChildWindow
static constexpr const char StaticWidgetType [] = "ChildWindow"
 Type name of the widget.
 

Protected Member Functions

void rearrange ()
 
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.
 
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 clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
- Protected Member Functions inherited from tgui::ChildWindow
void updateTitleBarHeight ()
 
void updateResizeMouseCursor (Vector2f mousePos)
 
void mouseEnteredWidget () override
 This function is called when the mouse enters the widget.
 
void mouseLeftWidget () override
 This function is called when the mouse leaves the widget.
 
- Protected Member Functions inherited from tgui::Container
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the child widgets to a render target.
 
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
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

String m_loadedThemeFile
 
String m_buttonClassName
 
bool m_autoSize = true
 
HorizontalAlignment m_labelAlignment = HorizontalAlignment::Left
 
HorizontalAlignment m_buttonAlignment = HorizontalAlignment::Center
 
std::vector< Button::Ptrm_buttons
 
Label::Ptr m_label = Label::create()
 
- Protected Attributes inherited from tgui::ChildWindow
Text m_titleText
 
Vector2f m_draggingPosition
 
Vector2f m_maximumSize = {std::numeric_limits<float>::infinity(), std::numeric_limits<float>::infinity()}
 
Vector2f m_minimumSize = {0, 0}
 
Layoutm_decorationLayoutX = nullptr
 
Layoutm_decorationLayoutY = nullptr
 
HorizontalAlignment m_titleAlignment = HorizontalAlignment::Center
 
unsigned int m_titleButtons = TitleButton::Close
 
unsigned int m_titleTextSize = 0
 
Cursor::Type m_currentChildWindowMouseCursor = Cursor::Type::Arrow
 
CopiedSharedPtr< Buttonm_closeButton
 
CopiedSharedPtr< Buttonm_minimizeButton
 
CopiedSharedPtr< Buttonm_maximizeButton
 
bool m_mouseDownOnTitleBar = false
 
bool m_keepInParent = false
 
bool m_positionLocked = false
 
bool m_resizable = false
 
int m_resizeDirection = ResizeNone
 
Sprite m_spriteTitleBar
 
Sprite m_spriteBackground
 
Borders m_bordersCached
 
Color m_borderColorCached
 
Color m_borderColorFocusedCached
 
Color m_titleColorCached
 
Color m_titleBarColorCached
 
Color m_backgroundColorCached
 
float m_titleBarHeightCached = 20
 
float m_borderBelowTitleBarCached = 0
 
float m_distanceToSideCached = 0
 
float m_paddingBetweenButtonsCached = 0
 
float m_minimumResizableBorderWidthCached = 10
 
bool m_showTextOnTitleButtonsCached = false
 
- 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
 
bool m_ignoreMouseEvents = false
 
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::ChildWindow
enum  ResizeDirection {
  ResizeNone = 0 , ResizeLeft = 1 , ResizeTop = 2 , ResizeRight = 4 ,
  ResizeBottom = 8
}
 
- 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

Message box widget.

Member Function Documentation

◆ addButton()

void tgui::MessageBox::addButton ( const String & buttonCaption)

Adds a button to the message box.

Parameters
buttonCaptionThe caption of the button

When receiving a callback with the ButtonClicked trigger then callback.text will contain this caption to identify the clicked button.

◆ changeButtons()

void tgui::MessageBox::changeButtons ( const std::vector< String > & buttonCaptions)

Adds, removes, or updates buttons from the message box.

Parameters
buttonCaptionsThe captions to assign to new or existing buttons.

This method has the following behaviour:

  • If the number of given captions is equal to the number of buttons added, each button will be renamed. The first button will be given the first caption in the vector, the second button the second caption, and so on.
  • If the number of given captions is greater than the number of buttons added, any existing buttons will be renamed as described above, and excess captions in buttonCaptions will be added as new buttons, in the order given in the vector.
  • If the number of given captions is smaller than the number of buttons added, any existing buttons will be renamed as described above, and buttons after the last renamed button will be removed.

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::MessageBox::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::ChildWindow.

◆ copy()

static TGUI_NODISCARD MessageBox::Ptr tgui::MessageBox::copy ( const MessageBox::ConstPtr & messageBox)
static

Makes a copy of another message box.

Parameters
messageBoxThe other message box
Returns
The new message box

◆ create()

static TGUI_NODISCARD MessageBox::Ptr tgui::MessageBox::create ( const String & title = "",
const String & text = "",
const std::vector< String > & buttons = {} )
static

Creates a new message box widget.

Parameters
titleTitle to display in the title bar of the message box
textText to display on the message box
buttonsButtons to display on the message box
Returns
The new message box

◆ getButtonAlignment()

TGUI_NODISCARD HorizontalAlignment tgui::MessageBox::getButtonAlignment ( ) const

Returns where the buttons are located inside the window (left side, centered or right side)

Returns
Alignment for the buttons

Buttons are centered by default.

◆ getButtons()

TGUI_NODISCARD std::vector< String > tgui::MessageBox::getButtons ( ) const

Returns the caption of the buttons.

Returns
Button texts

◆ getLabelAlignment()

TGUI_NODISCARD HorizontalAlignment tgui::MessageBox::getLabelAlignment ( ) const

Returns where the label is located inside the window (left side, centered or right side)

Returns
Alignment for the label

The label is left aligned by default.

◆ getRenderer()

TGUI_NODISCARD MessageBoxRenderer * tgui::MessageBox::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::ChildWindow.

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const MessageBoxRenderer * tgui::MessageBox::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::ChildWindow.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD MessageBoxRenderer * tgui::MessageBox::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::ChildWindow.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::MessageBox::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::ChildWindow.

◆ getText()

TGUI_NODISCARD const String & tgui::MessageBox::getText ( ) const

Returns the text of the message box.

Returns
Text that is being displayed inside the message box

◆ load()

void tgui::MessageBox::load ( const std::unique_ptr< DataIO::Node > & node,
const LoadingRenderersMap & renderers )
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::ChildWindow.

◆ rendererChanged()

void tgui::MessageBox::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::ChildWindow.

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::MessageBox::save ( SavingRenderersMap & renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::ChildWindow.

◆ setButtonAlignment()

void tgui::MessageBox::setButtonAlignment ( HorizontalAlignment buttonAlignment)

Changes where the buttons are located inside the window (left side, centered or right side)

Parameters
buttonAlignmentAlignment for the buttons

Buttons are centered by default.

◆ setClientSize()

void tgui::MessageBox::setClientSize ( const Layout2d & size)
overridevirtual

Changes the client size of the child window.

Parameters
sizeNew size of the child window contents

This sets the size of the child window excluding the title bar and the borders.

By default the size of the message box is determined by the text and buttons inside it. Calling this function will disable the auto-sizing of the window.

Reimplemented from tgui::ChildWindow.

◆ setLabelAlignment()

void tgui::MessageBox::setLabelAlignment ( HorizontalAlignment labelAlignment)

Changes where the label is located inside the window (left side, centered or right side)

Parameters
labelAlignmentAlignment for the label

The label is left aligned by default.

◆ setSize() [1/2]

void tgui::MessageBox::setSize ( const Layout2d & size)
overridevirtual

Changes the size of the message box.

Parameters
sizeSets the new size of the message box

This is the size of the entire child window, including the title bar and the borders. To set the size of the contents of the window (exluding the title bar and borders), use setClientSize instead.

By default the size of the message box is determined by the text and buttons inside it. Calling this function will disable the auto-sizing of the window.

Reimplemented from tgui::ChildWindow.

◆ setSize() [2/2]

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

◆ setText()

void tgui::MessageBox::setText ( const String & text)

Changes the text of the message box.

Parameters
textThe text displayed by the message box

The text will be placed as one long string and the message box will get the size needed to display the whole string. So if you need to display multiple lines of text then add '
' inside the text yourself.

◆ updateTextSize()

void tgui::MessageBox::updateTextSize ( )
overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Container.


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