iitem.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_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_IITEM_H__
#define __ANTARES_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_IITEM_H__
 
#include <memory>
 
class IItem
{
public:
    using Ptr = std::shared_ptr<IItem>;
    using Vector = std::vector<Ptr>;
    using VectorPtr = std::shared_ptr<Vector>;
    using GroupType = Yuni::CString<64, false>;
 
    class IPart
    {
    public:
        IPart()
        {
        }
        virtual ~IPart()
        {
        }
 
        virtual uint width() const;
        virtual uint height() const;
 
    }; // background color
 
    class Tag
    {
    public:
        using Ptr = std::shared_ptr<Tag>;
        using Vector = std::vector<Ptr>;
 
    public:
        template<class StringT>
        Tag(const StringT& t) : text(wxStringFromUTF8(t))
        {
        }
        Tag(const wxChar* t) : text(t)
        {
        }
        Tag(const wxString& t) : text(t)
        {
        }
        template<class StringT>
        Tag(const StringT& t, uint8_t r, uint8_t g, uint8_t b) :
         text(wxStringFromUTF8(t)), color(r, g, b)
        {
        }
        Tag(const wxChar* t, uint8_t r, uint8_t g, uint8_t b) : text(t), color(r, g, b)
        {
        }
        Tag(const wxString& t, uint8_t r, uint8_t g, uint8_t b) :
         text(t), color(r, g, b)
        {
        }
 
    public:
        wxString text;
        Yuni::Color::RGB<> color;
    };
 
public:
 
 
    IItem();
    virtual ~IItem();
 
 
    const Yuni::String& caption() const;
    template<class StringT>
    void caption(const StringT& caption);
    void caption(const wxString& caption);
 
    const Yuni::String& subcaption() const;
    template<class StringT>
    void subcaption(const StringT& caption);
 
 
 
    const GroupType& group() const;
    template<class StringT>
    void group(const StringT& g);
    template<class StringT>
    bool isSameGroup(const StringT& group) const;
 
 
    virtual bool canBeSelected() const;
 
 
    void image(const wxBitmap& bmp);
    void image(const wxBitmap* bmp);
    const wxBitmap& image() const;
 
 
    bool selected() const;
    void select();
    void unselect();
 
 
    template<class StringT>
    void addTag(const StringT& text);
    template<class StringT>
    void addTag(const StringT& text, uint8_t r, uint8_t g, uint8_t b);
    template<class StringT>
    void addRightTag(const StringT& text);
    template<class StringT>
    void addRightTag(const StringT& text, uint8_t r, uint8_t g, uint8_t b);
    void clearTags();
 
 
    bool countedAsResult() const;
    void countedAsResult(bool v);
 
 
 
    virtual void draw(wxDC& dc,
                      uint itemHeight,
                      wxRect& bounds,
                      bool selected,
                      const SearchToken::VectorPtr& tokens) const;
 
public:
    int tag;
 
protected:
    GroupType pGroup;
    Yuni::String pCaption;
    Yuni::String pSubCaption;
    wxBitmap pBitmap;
    bool pSelected;
    bool pCountedAsResult;
    Tag::Vector pLeftTags;
    Tag::Vector pRightTags;
    wxString pCacheCaption;
 
}; // class IITem
 
#endif // __ANTARES_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_IITEM_H__