TGUI  v0.6.10
Public Types | Public Member Functions | List of all members
tgui::MessageBox Class Reference
Inheritance diagram for tgui::MessageBox:
tgui::ChildWindow tgui::Container tgui::WidgetBorders tgui::Widget tgui::Transformable tgui::CallbackManager

Public Types

- Public Types inherited from tgui::ChildWindow
- Public Types inherited from tgui::Widget

Public Member Functions

 MessageBox ()
 Default constructor. More...
 
 MessageBox (const MessageBox &copy)
 Copy constructor. More...
 
virtual ~MessageBox ()
 Destructor. More...
 
MessageBoxoperator= (const MessageBox &right)
 Overload of assignment operator. More...
 
bool load (const std::string &configFileFilename, const std::string &sectionName="MessageBox")
 Loads the widget. 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 setTextFont (const sf::Font &font)
 Changes the font of the text. More...
 
const sf::Font * getTextFont () const
 Returns the font of the text. More...
 
void setTextColor (const sf::Color &color)
 Changes the color of the text. More...
 
const sf::Color & getTextColor () const
 Returns the color of the text. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the character 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
 ChildWindow ()
 Default constructor. More...
 
 ChildWindow (const ChildWindow &copy)
 Copy constructor. More...
 
virtual ~ChildWindow ()
 Destructor. More...
 
ChildWindowoperator= (const ChildWindow &right)
 Overload of assignment operator. More...
 
const std::string & getLoadedConfigFile () const
 Returns the filename of the config file that was used to load the widget. More...
 
void setSize (float width, float height)
 Changes the size of the child window. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the drawable area of the child window. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the size of the full child window. More...
 
void setBackgroundTexture (sf::Texture *const texture=nullptr)
 Changes the background texture of the child window. More...
 
sf::Texture * getBackgroundTexture ()
 Returns the background texture of the child window. More...
 
void setTitleBarHeight (unsigned int height)
 Change the height of the title bar. More...
 
unsigned int getTitleBarHeight () const
 Returns the height of the title bar. More...
 
void setBackgroundColor (const sf::Color &backgroundColor)
 Changes the background color of the child window. More...
 
const sf::Color & getBackgroundColor () const
 Returns the background color of the child window. More...
 
virtual void setTransparency (unsigned char transparency)
 Changes the transparency 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 setTitleColor (const sf::Color &color)
 Changes the color of the title that is displayed in the title bar of the child window. More...
 
const sf::Color & getTitleColor () const
 Returns the color of the title that is displayed in the title bar of the child window. More...
 
void setBorderColor (const sf::Color &borderColor)
 Set the border color. More...
 
const sf::Color & getBorderColor () const
 Returns the borde color. More...
 
virtual void setBorders (unsigned int leftBorder=0, unsigned int topBorder=0, unsigned int rightBorder=0, unsigned int bottomBorder=0)
 Changes the size of the borders. More...
 
void setDistanceToSide (unsigned int distanceToSide)
 Changes the distance between the title and the side of the title bar. More...
 
unsigned int getDistanceToSide () const
 Returns the distance between the title and the side of the title bar. More...
 
void setTitleAlignment (TitleAlignment alignment)
 Changes the title alignment. More...
 
TitleAlignment getTitleAlignment () const
 Returns the title alignment. More...
 
void setIcon (const std::string &filename)
 Changes the icon in the top left corner of the child window. More...
 
void removeIcon ()
 Removes the icon in the top left corner of the child window. More...
 
void destroy ()
 Destroys the window. More...
 
void keepInParent (bool enabled)
 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...
 
virtual sf::Vector2f getWidgetsOffset () 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). More...
 
void setPosition (float x, float y)
 Set the position of the widget. More...
 
- Public Member Functions inherited from tgui::Container
 Container ()
 Default constructor. More...
 
 Container (const Container &copy)
 Copy constructor. More...
 
virtual ~Container ()
 Destructor. More...
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
bool setGlobalFont (const std::string &filename)
 Changes the global font. More...
 
void setGlobalFont (const sf::Font &font)
 Changes the global font. More...
 
const sf::Font & getGlobalFont () const
 Returns the global font. 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...
 
Widget::Ptr copy (const Widget::Ptr &oldWidget, const sf::String &newWidgetName="")
 Makes a copy of any existing widget and returns the pointer to the new widget. More...
 
virtual void remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void remove (Widget *widget)
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container. More...
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
bool getWidgetName (const Widget::Ptr &widget, std::string &name) 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. More...
 
void uncheckRadioButtons ()
 Uncheck all the radio buttons. More...
 
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...
 
void bindGlobalCallback (std::function< void(const Callback &)> func)
 Bind a function to the callbacks of all child widgets. More...
 
template<typename T >
void bindGlobalCallback (void(T::*func)(const Callback &), T *const classPtr)
 Bind a function to the callbacks of all child widgets. More...
 
virtual void unbindGlobalCallback ()
 Unbind the global callback function(s). More...
 
bool loadWidgetsFromFile (const std::string &filename)
 Loads a form from a file. More...
 
bool saveWidgetsToFile (const std::string &filename)
 Save the widgets to a file. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor. More...
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
virtual ~Widget ()
 Destructor. More...
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget on the screen. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void hide ()
 Hides the widget. 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...
 
bool isDisabled () const
 Returns true when the widget is disabled. More...
 
bool isLoaded () const
 Returns true when the widget is loaded successfully. 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...
 
WidgetTypes getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
unsigned char getTransparency () const
 Returns the transparency of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setCallbackId (unsigned int callbackId)
 Changes the callback id of the widget. More...
 
unsigned int getCallbackId ()
 Returns the callback id of the widget. More...
 
- Public Member Functions inherited from tgui::Transformable
 Transformable ()
 Default constructor. More...
 
virtual ~Transformable ()
 Destructor. More...
 
void setPosition (const sf::Vector2f &position)
 set the position of the widget More...
 
const sf::Vector2f & getPosition () const
 get the position of the widget More...
 
void move (float offsetX, float offsetY)
 Move the widget by a given offset. More...
 
void move (const sf::Vector2f &offset)
 Move the widget by a given offset. More...
 
void scale (float factorX, float factorY)
 Scale the widget. More...
 
void scale (const sf::Vector2f &factors)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::CallbackManager
void bindCallback (std::function< void()> func, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
template<typename T >
void bindCallback (void(T::*func)(), T *const classPtr, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
void bindCallbackEx (std::function< void(const Callback &)> func, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
template<typename T >
void bindCallbackEx (void(T::*func)(const Callback &), T *const classPtr, unsigned int trigger)
 Bind a function to one or more specific callback trigger(s). More...
 
void bindCallback (unsigned int trigger)
 Bind one or more specific callback trigger(s) to the parent widget. More...
 
void unbindCallback (unsigned int trigger)
 Unbind all callback function bound to the given trigger. More...
 
void unbindAllCallback ()
 Unbind all callback functions bound to any callback. More...
 
- Public Member Functions inherited from tgui::WidgetBorders
 WidgetBorders ()
 Default constructor. More...
 
virtual ~WidgetBorders ()
 Destructor. More...
 
virtual Borders getBorders () const
 Returns the size of the borders as a tgui::Borders. More...
 

Member Enumeration Documentation

Defines specific triggers to MessageBox.

Enumerator
ButtonClicked 

Button clicked.

AllMessageBoxCallbacks 

All triggers defined in MessageBox and its base classes.

Constructor & Destructor Documentation

tgui::MessageBox::MessageBox ( )

Default constructor.

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

Copy constructor.

Parameters
copyInstance to copy
virtual tgui::MessageBox::~MessageBox ( )
virtual

Destructor.

Member Function Documentation

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.

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

Return the text of the message box.

Returns
Text that is being displayed inside the message box.
const sf::Color& tgui::MessageBox::getTextColor ( ) const

Returns the color of the text.

Returns
The current text color
const sf::Font* tgui::MessageBox::getTextFont ( ) const

Returns the font of the text.

Returns
Pointer to the font that is currently being used.
unsigned int tgui::MessageBox::getTextSize ( ) const

Returns the character size of the text.

Returns
The current text size.
bool tgui::MessageBox::load ( const std::string &  configFileFilename,
const std::string &  sectionName = "MessageBox" 
)
virtual

Loads the widget.

Parameters
configFileFilenameFilename of the config file.
sectionNameName of the section in the file to load

The config file must contain a MessageBox section with the needed information.

Reimplemented from tgui::ChildWindow.

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

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself
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.

void tgui::MessageBox::setTextColor ( const sf::Color &  color)

Changes the color of the text.

Parameters
colorNew text color
void tgui::MessageBox::setTextFont ( const sf::Font &  font)

Changes the font of the text.

When you don't call this function then the global font will be use. This global font can be changed with the setGlobalFont function from the parent.

Parameters
fontThe new font.
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 16.


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