exportmap.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_WINDOWS_EXPORTMAP_H__
#define __ANTARES_APPLICATION_WINDOWS_EXPORTMAP_H__
 
#include <antares/study/study.h>
#include <yuni/core/string.h>
#include "../application/study.h"
#include "../toolbox/components/map/settings.h"
 
#include <wx/sizer.h>
#include <wx/textctrl.h>
#include <wx/checkbox.h>
#include <wx/choice.h>
#include <wx/clrpicker.h>
#include <wx/combobox.h>
#include <wx/collpane.h>
#include <wx/dialog.h>
#include <wx/textctrl.h>
#include <wx/collpane.h>
#include <wx/valtext.h>
 
namespace Antares::Window
{
class ExportMap final: public wxDialog
{
public:
    static SaveResult Execute(wxFrame* parent, Data::Study::Ptr study);
 
public:
    enum
    {
        mnIDCollapsePanel = wxID_HIGHEST + 1,
        mnIDEditMapName,
        mnIDEditMapFolderName,
        mnIDBrowse,
        mnIDMapFormat,
    };
 
public:
    // \name Constructors & Destructor
 
    explicit ExportMap(wxFrame* parent);
    ExportMap(wxFrame* parent, Data::Study::Ptr study);
    virtual ~ExportMap();
 
 
    Data::Study::Ptr study();
    const Data::Study::Ptr study() const;
 
    SaveResult result() const;
 
private:
    void internalCreateComponents();
 
    void onCollapsePanel(wxCollapsiblePaneEvent& evt);
    void onMapNameChanged(wxCommandEvent& evt);
    void onMapFolderNameChanged(wxCommandEvent& evt);
    void onBrowse(wxCommandEvent& evt);
    void ensureUniqueFileName(Yuni::String folderPath);
 
    void onMapFormatChanged(wxCommandEvent& evt);
 
    void onUseBackgroundChanged(wxCommandEvent& evt);
 
    void onCancel(void*);
    void onExportMap(void*);
 
    wxString getFormatAsString(Antares::Map::mapImageFormat format);
    YString getFormatAsYString(Antares::Map::mapImageFormat format);
 
    void propCaption(const wxString& text, bool bold = false);
    wxTextCtrl* propEdit(const wxString& defaultValue = wxString(), int id = wxID_ANY);
    wxWindow* propEdit(wxWindow* control);
    wxTextCtrl* propEdit(const wxString& defaultValue,
                         const wxTextValidator& validator,
                         int id = wxID_ANY);
 
private:
    Data::Study::Ptr pStudy;
    wxFlexGridSizer* pGridSizer;
    wxWindow* pParentProperties;
    wxTextCtrl* pMapName;
    wxTextCtrl* pMapFolderName;
    wxTextCtrl* pMapFolderPath;
    bool pCustomMapFolderName;
 
    wxChoice* pMapFormatChoice;
    Antares::Map::mapImageFormat pMapFormat;
 
    wxComboBox* pLayers;
    wxCheckBox* pSplit;
    wxChoice* pSplitNumberChoice;
    wxCheckBox* pUseBackgroundColor;
    wxColourPickerCtrl* pBackgroundColor;
 
    SaveResult pResult;
 
    static wxString defaultPath;
 
    // Event Table
    DECLARE_EVENT_TABLE()
 
}; // class ExportMap
 
} // namespace Antares::Window
 
#include "exportmap.hxx"
 
#endif // __ANTARES_APPLICATION_WINDOWS_EXPORTMAP_H__