MessageBox.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_MESSAGE_BOX_HPP
#define TGUI_MESSAGE_BOX_HPP
 
#include <TGUI/Renderers/MessageBoxRenderer.hpp>
#include <TGUI/Widgets/Button.hpp>
#include <TGUI/Widgets/ChildWindow.hpp>
#include <TGUI/Widgets/Label.hpp>
 
#undef MessageBox // windows.h defines MessageBox when NOMB isn't defined before including windows.h

 
namespace tgui
{
    class TGUI_API MessageBox : public ChildWindow
    {
    public:
        using Ptr = std::shared_ptr<MessageBox>;            
        using ConstPtr = std::shared_ptr<const MessageBox>; 
 
        static constexpr char StaticWidgetType[] = "MessageBox"; 

        using Alignment TGUI_DEPRECATED("Use tgui::HorizontalAlignment instead") = HorizontalAlignment; // TGUI_NEXT: Remove this alias

        explicit MessageBox(const char* typeName = StaticWidgetType, bool initRenderer = true);

        [[nodiscard]] static MessageBox::Ptr create(const String& title = "",
                                                    const String& text = "",
                                                    const std::vector<String>& buttons = {});

        MessageBox(const MessageBox& other);

        MessageBox(MessageBox&& other) noexcept;

        MessageBox& operator=(const MessageBox& other);

        MessageBox& operator=(MessageBox&& other) noexcept;

        [[nodiscard]] static MessageBox::Ptr copy(const MessageBox::ConstPtr& messageBox);

        [[nodiscard]] MessageBoxRenderer* getSharedRenderer() override;
        [[nodiscard]] const MessageBoxRenderer* getSharedRenderer() const override;

        [[nodiscard]] MessageBoxRenderer* getRenderer() override;

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void setClientSize(const Layout2d& size) override;

        void setText(const String& text);

        [[nodiscard]] const String& getText() const;

        void addButton(const String& buttonCaption);

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

        [[nodiscard]] std::vector<String> getButtons() const;

        void setLabelAlignment(HorizontalAlignment labelAlignment);

        [[nodiscard]] HorizontalAlignment getLabelAlignment() const;

        void setButtonAlignment(HorizontalAlignment buttonAlignment);

        [[nodiscard]] HorizontalAlignment getButtonAlignment() const;

 
    protected:
        // Makes sure all widgets lie within the window and places them on the correct position.
        void rearrange();

        [[nodiscard]] Signal& getSignal(String signalName) override;

        void rendererChanged(const String& property) override;

        [[nodiscard]] std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;

        void updateTextSize() override;

        // Makes a copy of the widget
        [[nodiscard]] Widget::Ptr clone() const override;

 
    private:
        // Figure out which widget is the label and which are the buttons after copying or loading
        void identifyLabelAndButtons();

        // Passes our onButtonPress signal handler to the onPress signal of a button
        void connectButtonPressSignal(std::size_t buttonIndex);

        void addButtonImpl(const String& caption);

 
    public:
        SignalString onButtonPress = {"ButtonPressed"}; 

 
    protected:
        String m_loadedThemeFile;
        String m_buttonClassName;
        bool m_autoSize = true;
        HorizontalAlignment m_labelAlignment = HorizontalAlignment::Left;
        HorizontalAlignment m_buttonAlignment = HorizontalAlignment::Center;
 
        std::vector<Button::Ptr> m_buttons;
 
        Label::Ptr m_label = Label::create();
    };
} // namespace tgui
 
#endif // TGUI_MESSAGE_BOX_HPP