message.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_APPLICATION_MESSAGE_H__
#define __ANTARES_APPLICATION_MESSAGE_H__
 
#include <yuni/thread/thread.h>
#include <wx/dialog.h>
#include <ui/common/component/spotlight.h>
 
namespace Antares::Window
{
class Message final: public wxDialog
{
public:
    enum DefaultButtonType
    {
        btnStartID = 100000,
        btnOk,
        btnYes,
        btnNo,
        btnRetry,
        btnDiscard,
        btnQuitWithoutSaving,
        btnSaveChanges,
        btnCancel,
        btnSaveAs,
        btnUpgrade,
        btnContinue,
        btnViewResults,
        btnQuit
    };
 
    using ItemList = std::vector<Component::Spotlight::IItem::Ptr>;
 
public:
 
 
    Message(wxWindow* parent,
            const wxString& title,
            const wxString& subtitle = wxEmptyString,
            const wxString& msg = wxEmptyString,
            const char* icon = "images/misc/book.png");
    virtual ~Message();
 
 
 
    void add(const wxString& caption,
             DefaultButtonType value,
             bool defaultButton = false,
             int space = 3);
 
    void add(DefaultButtonType btn, bool defaultButton = false, int space = 3);
 
 
 
    void add(Component::Spotlight::IItem::Ptr item);
    void appendError(const AnyString& text);
    void appendWarning(const AnyString& text);
 
    Message& operator+=(Component::Spotlight::IItem::Ptr item);
 
 
 
    uint showModal();
 
    void showModalAsync();
 
 
 
    void recommendedWidth(uint w);
 
private:
    void onButtonClick(DefaultButtonType userdata);
    //
    void prepareShowModal();
 
private:
    wxPanel* pPanel;
    wxBoxSizer* pPanelSizer;
    ItemList pItemList;
    Component::Spotlight* pSpotlight;
    wxSizer* pListSizer;
    DefaultButtonType pReturnStatus;
    uint pRecommendedWidth;
    wxPanel* pSpace;
 
}; // class Message
 
} // namespace Antares::Window
 
#include "message.hxx"
 
#endif // __ANTARES_APPLICATION_MESSAGE_H__