IIndicator.hpp

Go to the documentation of this file.

#ifndef LIBS_GUI_IINDICATOR_HPP_
#define LIBS_GUI_IINDICATOR_HPP_
 
#include "ui/gui/AbstractComponentGUI.hpp"
 
#include <optional>
#include <string>
 
class IIndicator
{
public:
    enum class EDialogPosition
    {
        RightDown,
        WithIcon
    };
 
    enum class eIndicatorRepresentationType
    {
        IconLarge,    // Large icon that occupies the entire width of the indicator
        IconWithBadge,// Large icon with a badge in the top left corner
        IconWithText  // Left text and right icon that occupies half the width of the indicator
    };
 
    IIndicator() = default;
    virtual ~IIndicator() = default;
 
    virtual void updateIndicator() = 0;
 
    virtual AbstractComponentGUI *panel() = 0;
 
    [[nodiscard]] virtual IIndicator::EDialogPosition getPosition() const = 0;
    [[nodiscard]] virtual eIndicatorRepresentationType representationType() const = 0;
 
    virtual std::optional<std::string> processIndicatorIcon() = 0;
    virtual std::optional<std::string> processIndicatorText() = 0;
    virtual std::optional<iv::types::color> processIndicatorTextColor() = 0;
    virtual std::optional<iv::types::color> processIndicatorBackground() = 0;
 
    [[nodiscard]] virtual bool isVisible() const = 0;  // If it's visible
    [[nodiscard]] virtual bool isClickable() const = 0;// If it's clickable
 
    // If the panel should be displayed without selecting the indicator
    [[nodiscard]] virtual bool displayPanelDynamic() const = 0;
};
 
#endif /* LIBS_GUI_IINDICATOR_HPP_ */