notebook.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_TOOLBOX_COMPONENT_NOTEBOOK_H__
#define __ANTARES_TOOLBOX_COMPONENT_NOTEBOOK_H__
 
#include <ui/common/component/panel.h>
#include <vector>
#include <wx/dc.h>
#include "../../input/input.h"
#include "../refresh.h"
 
namespace Antares::Component
{
class Notebook: public Panel
{
public:
    enum Orientation
    {
        orLeft,
        orTop,
    };
 
    enum Theme
    {
        themeDefault,
        themeLight,
    };
 
    enum Alignment
    {
        alignRight,
        alignLeft,
    };
 
public:
    class Tabs;
 
public:
    class Page
    {
        friend class Tabs;
        friend class Notebook;
        friend class MapNotebook;
 
    public:
 
        Page(Notebook& notebook);
        Page(Notebook& notebook, wxWindow* ctrnl, const wxString& caption);
        Page(Notebook& notebook, wxWindow* ctrnl, const wxString& name, const wxString& caption);
        ~Page();
 
 
        Notebook& notebook();
        const Notebook& notebook() const;
 
 
        const wxString& caption() const;
        void caption(const wxString& s);
 
 
        const wxString& name() const;
        void name(const wxString& s);
 
 
 
        bool selected() const
        {
            return pSelected;
        }
 
        Page* select(bool force = false);
        void selectSubPage(Page* subPage);
 
 
 
        bool visible() const
        {
            return pVisible;
        }
 
        void visible(const bool v);
 
 
 
        bool displayExtraControls() const
        {
            return pDisplayExtraControls;
        }
 
        void displayExtraControls(bool v)
        {
            pDisplayExtraControls = v;
        }
 
        wxWindow* control() const
        {
            return pControl;
        }
 
        void refresh()
        {
            RefreshAllControls(pControl);
        }
 
 
 
        void removeSubPage(Page* p);
        Page* addSubPage(Page* p);
 
    private:
        std::vector<Page*> subPages;
 
    private:
        void onSelectPage();
 
    private:
        Notebook& pNotebook;
        wxWindow* pControl;
        wxString pName;
        wxString pCaption;
        wxRect pBoundingBox;
        bool pSelected;
        bool pVisible;
        bool pDisplayExtraControls;
 
    }; // class Page
 
    friend class Page;
 
public:
 
 
    Notebook(wxWindow* parent, Orientation orientation = orLeft);
    virtual ~Notebook();
 
 
    Orientation orientation() const;
 
    void clear();
 
    Page* add(wxWindow* ctnrl, const wxString& caption);
 
    Page* add(wxWindow* ctnrl, const wxString& name, const wxString& caption);
 
    void addSeparator();
 
 
    bool tabsVisible() const;
    void tabsVisible(bool v);
 
    bool alwaysDisplayTabs() const;
    void alwaysDisplayTabs(const bool v);
 
    bool displayTitle() const;
    void displayTitle(const bool v);
 
    void addCommonControl(Toolbox::InputSelector::AInput* input, const int border = 0);
    void addCommonControl(wxWindow* ctrnl,
                          const int border = 0,
                          const wxPoint& recommendedSize = wxPoint(20, 20));
 
    void addCommonControlTop(Toolbox::InputSelector::AInput* input, const int border = 0);
    void addCommonControlTop(wxWindow* ctrnl,
                             const int border = 0,
                             const wxPoint& recommendedSize = wxPoint(20, 20));
 
 
    const wxString& caption() const;
    void caption(const wxString& s);
 
    bool select(const wxString& name, bool triggerEvents = true);
 
    Page* selected()
    {
        return pLastSelected;
    }
 
    const Page* selected() const
    {
        return pLastSelected;
    }
 
    Page* find(const wxString& name);
 
    void set_page_visibility(const wxString& name, bool visible);
 
 
 
    void theme(Theme t)
    {
        pTheme = t;
    }
 
    Theme theme() const
    {
        return pTheme;
    }
 
 
    void alignment(Alignment a)
    {
        pAlignment = a;
    }
 
    wxWindow* titlePanelControl() const;
 
    void enableRefreshForAllDatagrid(bool enabled);
 
    // From wxWidgets standard API
    virtual bool HasMultiplePages() const;
 
    void forceRefresh();
 
public:
    Yuni::Event<void(Page&, bool&)> onPageAccept;
 
    Yuni::Event<void(Page&)> onPageChanged;
 
public:
    class Tabs: public Panel
    {
        friend class Notebook;
 
    public:
        Tabs(wxWindow* parent, Notebook& notebook);
        virtual ~Tabs();
 
        virtual void onMouseUp(wxMouseEvent&);
        void drawItem(wxDC& dc, Page* page, int& pos);
        virtual void drawItemTop(wxDC& dc, Page* page, int& pos, Alignment align);
        void drawItemOnCanvasNotSelected(Page* page,
                                         wxDC& dc,
                                         const int pos,
                                         const int h,
                                         const wxSize& textExtent);
        void drawItemOnCanvasSelected(Page* page,
                                      wxDC& dc,
                                      const int pos,
                                      const int h,
                                      const wxSize& textExtent);
 
        Notebook& pNotebook;
 
    protected:
        virtual void onDraw(wxPaintEvent& evt);
        void onEraseBackground(wxEraseEvent& evt);
        void drawOrientationLeft(wxDC& dc);
        void drawOrientationTop(wxDC& dc);
        void onForceRefresh();
        wxPoint pCachedSize;
 
        wxRect pRect;
        int pMaxFound;
        // A SegV occurs for an unknon reason when using a wxPoint on the stack
        // when calling DrawPolygon.
        // (MinGW TDM 4.4.1 - Windows XP - wxWidgets 2.8.10)
        // It seems that the drawing context uses it later
        wxPoint pPts[3];
 
        DECLARE_EVENT_TABLE()
    };
 
private:
    void onForceRefresh();
 
public:
    friend class Tabs;
    const Orientation pOrientation;
    using Pages = std::vector<Page*>;
    Pages pPages;
    Tabs* pTabs;
    wxString pCaption;
    bool pTabsVisible;
    bool pAlwaysDisplayTab;
    bool pDisplayTitle;
 
    wxSizer* pSizerForPages;
    wxSizer* pTopSizer;
    wxSizer* pLeftSizer;
 
    Page* pLastSelected;
 
    std::vector<wxWindow*> pExtraControls;
 
    Theme pTheme;
    Alignment pAlignment;
 
    wxString pCacheTitle;
    wxColour pOriginalColor;
    wxColour pOriginalColorDark;
 
}; // class Notebook
 
} // namespace Antares::Component
 
#include "notebook.hxx"
 
#endif // __ANTARES_TOOLBOX_COMPONENT_NOTEBOOK_H__