notes.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_NOTES_H__
#define __ANTARES_APPLICATION_WINDOWS_NOTES_H__
 
#include <ui/common/component/panel.h>
#include <wx/richtext/richtextctrl.h>
#include <wx/richtext/richtextstyles.h>
 
namespace Antares::Window
{
class Notes final: public Antares::Component::Panel, public Yuni::IEventObserver<Notes>
{
public:
    enum IDs
    {
        mnIDUserNotes = wxID_HIGHEST + 1,
    };
 
    static Yuni::Event<void(Notes* sender)> OnChanged;
 
public:
    // \name Constructors & Destructor
 
    Notes(wxWindow* parent, uint margin = 18);
    virtual ~Notes();
 
    void saveToStudy();
 
    void loadFromStudy();
 
    void connectToNotification();
 
    void disconnectFromNotification();
 
private:
    void onBold(void*);
    void onItalic(void*);
    void onUnderline(void*);
 
    void onAlignLeft(void*);
    void onAlignRight(void*);
    void onAlignCenter(void*);
 
    void onListBullet(void*);
    void onListNumbered(void*);
 
    void onIndentIncrease(void*);
    void onIndentDecrease(void*);
 
    void appendStyles();
 
    void onUserNotesCharacter(wxRichTextEvent& evt);
    void onUserNotesStyleChanged(wxRichTextEvent& evt);
 
    void onNotesModified(Notes* sender);
 
    void notifyChanges();
 
    void onStudyClosed();
 
    bool initializeTemporaryFile();
 
private:
    wxRichTextCtrl* pRichEdit;
    wxRichTextStyleSheet* pStyleSheet;
    uint pLocalRevision;
    uint pUpdatesToSkip;
 
    YString pTempFile;
 
    // Event Table
    DECLARE_EVENT_TABLE()
 
}; // class Notes
 
} // namespace Antares::Window
 
#endif // __ANTARES_APPLICATION_WINDOWS_NOTES_H__