renderer.h

/*
** Copyright 2007-2024, 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_DATAGRID_RENDERER_H__
#define __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_H__
 
#include <yuni/core/event.h>
#include <antares/date/date.h>
#include <wx/colour.h>
#include "default.h"
#include <antares/study/study.h>
 
#ifdef YUNI_OS_MSVC
// Disable warning C4250, inherits via dominance
#pragma warning(disable : 4250)
#endif
 
namespace Antares
{
namespace Component
{
namespace Datagrid
{
    class VGridHelper;
namespace Renderer
{
class IRenderer : public Yuni::IEventObserver<IRenderer>
{
public:
    enum CellStyle
    {
        cellStyleDefault = 0,
        cellStyleCustom,
        cellStyleDefaultAlternate,
        cellStyleDefaultDisabled,
        cellStyleDefaultAlternateDisabled,
        cellStyleDefaultCenter,
        cellStyleDefaultCenterAlternate,
        cellStyleDefaultCenterDisabled,
        cellStyleDefaultCenterAlternateDisabled,
        cellStyleWarning,
        cellStyleError,
        cellStyleDisabled,
        cellStyleAverage,
        cellStyleSum,
        cellStyleMinMax,
        cellStyleConstraintEnabled,
        cellStyleConstraintDisabled,
        cellStyleConstraintNoWeight,
        cellStyleConstraintWeight,
        cellStyleConstraintWeightCount,
        cellStyleConstraintOperator,
        cellStyleConstraintType,
        cellStyleLayerDisabled,
        cellStyleFilterYearByYearOn,
        cellStyleFilterYearByYearOff,
        cellStyleFilterSynthesisOn,
        cellStyleFilterSynthesisOff,
        cellStyleFilterUndefined,
        cellStyleAdqPatchVirtual,
        cellStyleAdqPatchOutside,
        cellStyleAdqPatchInside,
 
 
        cellStyleMax /* Max items in the list */
    };
 
    static const wxChar* CellStyleToCSSClass(CellStyle s);
    static void CellStyleToCSSClass(CellStyle s, Yuni::String& str);
 
public:
 
 
    IRenderer();
    virtual ~IRenderer();
 
 
    virtual bool valid() const = 0;
 
 
 
    virtual int width() const = 0;
 
    virtual int height() const = 0;
 
    virtual int internalWidth() const;
    virtual int internalHeight() const;
 
 
 
    virtual wxString columnCaption(int colIndx) const = 0;
 
    virtual wxString rowCaption(int rowIndx) const = 0;
 
 
 
    virtual wxString asString(int x, int y) const;
    virtual double asDouble(int x, int y) const;
 
    virtual wxString cellValue(int x, int y) const = 0;
 
    void appendCellValue(int x, int y, Yuni::String& s) const;
 
    virtual double cellNumericValue(int x, int y) const = 0;
 
    virtual bool cellValue(int x, int y, const Yuni::String& value) = 0;
 
 
    virtual void resetColors(int x,
                             int y,
                             wxColour& background,
                             wxColour& textForeground) const = 0;
 
 
    virtual IRenderer::CellStyle cellStyle(int, int y) const;
    IRenderer::CellStyle cellStyleWithNumericCheck(int x, int y) const;
 
    virtual wxColour cellBackgroundColor(int, int) const;
    virtual wxColour cellTextColor(int, int) const;
 
    virtual wxColour verticalBorderColor(int x, int y) const;
 
    virtual wxColour horizontalBorderColor(int x, int y) const;
 
    virtual int cellAlignment(int x, int y) const;
 
    virtual int columnWidthCustom(int x) const;
    virtual void hintForColumnWidth(int x, wxString& out) const;
 
    virtual Date::Precision precision();
 
    virtual bool ensureDataAreLoaded();
 
 
 
    virtual uint maxWidthResize() const;
    virtual uint maxHeightResize() const;
 
    virtual void resizeMatrixToXColumns(uint /*m*/)
    {
    }
 
    virtual bool onMatrixResize(uint oldX, uint oldY, uint& newX, uint& newY);
 
    virtual void onMatrixLoad()
    {
    }
 
    virtual bool circularShiftRowsUntilDate(MonthName month, uint daymonth);
 
 
 
    virtual void onSelectCell(uint, uint)
    {
    }
    virtual void onScroll()
    {
    }
 
    virtual void applyLayerFiltering(size_t layerID, VGridHelper* gridHelper);
 
public:
    Yuni::Event<void()> onRefresh;
    // This property is set by VGridHelper
    Date::Precision dataGridPrecision;
    Data::Study::Ptr study;
 
    bool invalidate;
 
protected:
    virtual void onStudyClosed();
    virtual void onStudyLoaded();
 
}; // class IRenderer
 
} // namespace Renderer
} // namespace Datagrid
} // namespace Component
} // namespace Antares
 
#include "renderer.hxx"
 
#endif // __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_H__