TGUI  0.7.4

Message box widget. More...

#include <MessageBox.hpp>

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

Public Types

typedef std::shared_ptr< MessageBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const MessageBoxConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ChildWindow
enum  TitleAlignment { TitleAlignment::Left, TitleAlignment::Center, TitleAlignment::Right }
 Title alignments, possible options for the setTitleAlignment function. More...
 
enum  TitleButtons { None = 0, Close = 1 << 0, Minimize = 1 << 1, Maximize = 1 << 2 }
 Title buttons (bitwise OR to combine) More...
 
typedef std::shared_ptr< ChildWindowPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ChildWindowConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
typedef std::shared_ptr< ContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 MessageBox (const MessageBox &copy)
 Copy constructor. More...
 
MessageBoxoperator= (const MessageBox &right)
 Overload of assignment operator. More...
 
std::shared_ptr< MessageBoxRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setFont (const Font &font) override
 Changes the font of the text in the widget and its children. More...
 
void setText (const sf::String &text)
 Change the text of the message box. More...
 
sf::String getText () const
 Return the text of the message box. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the size of the text. More...
 
void addButton (const sf::String &buttonCaption)
 Add a button to the message box. More...
 
- Public Member Functions inherited from tgui::ChildWindow
std::shared_ptr< ChildWindowRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (const Layout2d &position) override
 Set the position of the widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the child window. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the size of the full child window. More...
 
void setMaximumSize (sf::Vector2f size)
 Sets the maximum size of the child window. More...
 
sf::Vector2f getMaximumSize () const
 Returns the maximum size of the child window. More...
 
void setMinimumSize (sf::Vector2f size)
 Sets the minimum size of the child window. More...
 
sf::Vector2f getMinimumSize () const
 Returns the minimum size of the child window. More...
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the widget. More...
 
void setTitle (const sf::String &title)
 Changes the title that is displayed in the title bar of the child window. More...
 
const sf::String & getTitle () const
 Returns the title that is displayed in the title bar of the child window. More...
 
void setTitleAlignment (TitleAlignment alignment)
 Changes the title alignment. More...
 
TitleAlignment getTitleAlignment () const
 Returns the title alignment. More...
 
void setTitleButtons (TitleButtons buttons)
 Changes the title buttons. More...
 
TitleButtons getTitleButtons () const
 Returns the title bar buttons. More...
 
void setTitleButtonsText (const sf::String &closeText="x", const sf::String &minimizeText="-", const sf::String &maximizeText="+")
 Changes the text within the title bar buttons. More...
 
void setIcon (const Texture &icon)
 Changes the icon in the top left corner of the child window. More...
 
const TexturegetIcon ()
 Returns the icon in the top left corner of the child window. More...
 
void destroy ()
 Destroys the window. More...
 
void setResizable (bool resizable=true)
 Changes whether the child window can be resized by dragging its borders or not. More...
 
bool isResizable () const
 Check whether the child window can be resized by dragging its borders or not. More...
 
void keepInParent (bool enabled=true)
 Set the child window to be kept inside its parent. More...
 
bool isKeptInParent () const
 Tells whether the child window is kept inside its parent. More...
 
void setCloseButton (Button::Ptr closeButton)
 Change the close button. More...
 
Button::Ptr getCloseButton () const
 Returns the close button. More...
 
void setMinimizeButton (Button::Ptr minimizeButton)
 Change the minimize button. More...
 
Button::Ptr getMinimizeButton () const
 Returns the minimize button. More...
 
void setMaximizeButton (Button::Ptr maximizeButton)
 Change the maximize button. More...
 
Button::Ptr getMaximizeButton () const
 Returns the maximize button. More...
 
virtual sf::Vector2f getChildWidgetsOffset () const override
 Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0). More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
const std::vector< Widget::Ptr > & getWidgets ()
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames ()
 Returns a list of the names of all the widgets. More...
 
virtual void add (const Widget::Ptr &widgetPtr, const sf::String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. More...
 
virtual bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
std::string getWidgetName (const Widget::Ptr &widget) const
 Returns the name of a widget. More...
 
void focusWidget (const Widget::Ptr &widget)
 Focuses a widget. More...
 
void focusWidget (Widget *const widget)
 Focuses a widget. More...
 
void focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocus all the widgets.
 
void uncheckRadioButtons ()
 Uncheck all the radio buttons.
 
void loadWidgetsFromFile (const std::string &filename)
 Load the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Save the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Load the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream)
 Save the child widgets to a text file. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable (bool blockMouseEvents=true)
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Static Public Member Functions

static MessageBox::Ptr create ()
 Creates a new message box widget. More...
 
static MessageBox::Ptr copy (MessageBox::ConstPtr messageBox)
 Makes a copy of another message box. More...
 
- Static Public Member Functions inherited from tgui::ChildWindow
static ChildWindow::Ptr create ()
 Creates a new child window widget. More...
 
static ChildWindow::Ptr copy (ChildWindow::ConstPtr childWindow)
 Makes a copy of another child window. More...
 

Protected Member Functions

virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
 Reload the widget. More...
 
virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Container
void moveWidgetToFront (Widget *const widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (Widget *const widget)
 Places a widget behind all other widgets. More...
 
- Protected Member Functions inherited from tgui::Widget
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 

Detailed Description

Message box widget.

Signals:

  • ButtonPressed (one of the buttons was pressed)
    • Optional parameter sf::String: Caption of the button
    • Uses Callback member 'text'
  • Inherited signals from ChildWindow

Constructor & Destructor Documentation

◆ MessageBox()

tgui::MessageBox::MessageBox ( const MessageBox copy)

Copy constructor.

Parameters
copyInstance to copy

Member Function Documentation

◆ addButton()

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

Add 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.

◆ clone()

virtual Widget::Ptr tgui::MessageBox::clone ( ) const
inlineoverrideprotectedvirtual

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 MessageBox::Ptr tgui::MessageBox::copy ( MessageBox::ConstPtr  messageBox)
static

Makes a copy of another message box.

Parameters
messageBoxThe other message box
Returns
The new message box

◆ create()

static MessageBox::Ptr tgui::MessageBox::create ( )
static

Creates a new message box widget.

Returns
The new message box

◆ getRenderer()

std::shared_ptr<MessageBoxRenderer> tgui::MessageBox::getRenderer ( ) const
inline

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

Returns
Reference to the renderer

◆ getText()

sf::String tgui::MessageBox::getText ( ) const
inline

Return the text of the message box.

Returns
Text that is being displayed inside the message box.

◆ getTextSize()

unsigned int tgui::MessageBox::getTextSize ( ) const
inline

Returns the size of the text.

Returns
The current text size

◆ operator=()

MessageBox& tgui::MessageBox::operator= ( const MessageBox right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ reload()

virtual void tgui::MessageBox::reload ( const std::string &  primary = "",
const std::string &  secondary = "",
bool  force = false 
)
overrideprotectedvirtual

Reload the widget.

Parameters
primaryPrimary parameter for the loader
secondarySecondary parameter for the loader
forceTry to only change the looks of the widget and not alter the widget itself when false
Exceptions
Exceptionwhen the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented from tgui::ChildWindow.

◆ setFont()

virtual void tgui::MessageBox::setFont ( const Font font)
overridevirtual

Changes the font of the text in the widget and its children.

Parameters
fontThe new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::ChildWindow.

◆ setText()

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

Change 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.

◆ setTextSize()

void tgui::MessageBox::setTextSize ( unsigned int  size)

Changes the character size of the text.

Parameters
sizeThe new text size.

By default, the text size is 18.


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