TGUI  0.8-dev

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  TitleButton { None = 0, Close = 1 << 0, Maximize = 1 << 1, Minimize = 1 << 2 }
 Title buttons (use 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...
 
MessageBoxRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setText (const sf::String &text)
 Changes the text of the message box. More...
 
const sf::String & getText () const
 Returns 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)
 Adds a button to the message box. More...
 
std::vector< sf::String > getButtons () const
 Returns the caption of the buttons. More...
 
- Public Member Functions inherited from tgui::ChildWindow
ChildWindowRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (const Layout2d &position) override
 Sets 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...
 
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 (unsigned int buttons)
 Changes the title buttons. More...
 
unsigned int getTitleButtons () const
 Returns the title bar buttons. 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
 Checks whether the child window can be resized by dragging its borders or not. More...
 
void keepInParent (bool enabled=true)
 Sets the child window to be kept inside its parent. More...
 
bool isKeptInParent () const
 Tells whether the child window is kept inside its parent. 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...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames () const
 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 focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocuses all the widgets.
 
void uncheckRadioButtons ()
 Unchecks all the radio buttons.
 
void loadWidgetsFromFile (const std::string &filename)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream)
 Saves the child widgets to a text file. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
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 sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. 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 ()
 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...
 
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...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void move (const Layout2d &offset)
 Moves the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Moves 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)
 Scales the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scales the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
virtual ~SignalWidgetBase ()
 Virtual destructor.
 
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)
 Disconnects all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnects 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 rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. 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::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.
 

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)

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.

§ 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

§ getButtons()

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

Returns the caption of the buttons.

Returns
Button texts

§ getRenderer()

MessageBoxRenderer* tgui::MessageBox::getRenderer ( ) const
inline

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

Returns
Temporary pointer to the renderer

§ getText()

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

Returns the text of the message box.

Returns
Text that is being displayed inside the message box

§ getTextSize()

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

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

§ rendererChanged()

virtual void tgui::MessageBox::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::ChildWindow.

§ setText()

void tgui::MessageBox::setText ( const sf::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.

§ 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: