AbstractComponentGUI.hpp

Go to the documentation of this file.

#ifndef LIBS_GUI_ABSTRACTCOMPONENTGUI_HPP_
#define LIBS_GUI_ABSTRACTCOMPONENTGUI_HPP_
 
#include "core/defines.hpp"
#include "core/memOps.hpp"
#include "core/types.hpp"
#include "ui/gui/CEnumComponentsGUI.hpp"
#include "ui/gui/IDataPanel.hpp"
#include "ui/gui/IListenerAccept.hpp"
#include "ui/gui/IListenerChange.hpp"
#include "ui/gui/IListenerClose.hpp"
#include "ui/gui/IListenerIsAccept.hpp"
#include "ui/gui/IListenerUpdate.hpp"
#include "ui/gui/IListenerValidate.hpp"
 
#include <bits/stdint-uintn.h>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
class CAttrColorComp;
class CDialog;
class IComponentsGUI;
class IListenerTimer;
class IWidget;
 
class AbstractComponentGUI
{
public:
    AbstractComponentGUI();
    AbstractComponentGUI(const AbstractComponentGUI &) = delete;
    virtual ~AbstractComponentGUI();
 
    CDialog *getDialogFatherRef();
    void setDialogFatherOption(CDialog *dialogFatherRef);
 
    [[nodiscard]] std::string getTooltip() const;
    [[nodiscard]] bool getActive() const;
    [[nodiscard]] bool getInactiveVisualFeedback() const;
    void getSize(double *sizeX, double *sizeY) const;
 
    IWidget *makeWidget(CDialog *dialogFatherRef, AbstractComponentGUI *componentFatherRef);
    virtual void destroyWidget();
 
    void addDataPanel(IDataPanel **dataPanel);
 
    void addListenerAccept(IListenerAccept **listenerAccept);
    void addListenerValidate(IListenerValidate **listenerValidate);
    void addListenerChange(IListenerChange **listenerChange);
    void addListenerClose(IListenerClose **listenerClose);
    void addListenerIsAccept(IListenerIsAccept **listenerIsAccept);
    void addListenerUpdate(IListenerUpdate **listenerUpdate);
    void addListenerTimer(uint64_t timeout, IListenerTimer **timer);
 
    void emplaceListenerAccept(std::function<void()> acceptFunctionCall);
    void emplaceListenerClose(std::function<void()> closeFunctionCall);
    void emplaceListenerChange(std::function<void(CDialog *, AbstractComponentGUI *)> changeFunctionCall);
    void emplaceListenerIsAccept(std::function<bool(AbstractComponentGUI *, std::string *)> isAcceptFunctionCall);
    void emplaceListenerTimer(uint64_t timeout, std::function<bool()> timerExecutionFunctionCall);
 
    bool runValidate();
    void runChange();
    void runClose();
    bool runListenersIsAccept(std::string *messageError);
    void runListenersAccept();
    void runListenersUpdate();
 
    void displayPopOver(std::string_view message, iv::types::milliseconds timeout = 2000);
 
    void grabFocus();
    void setName(const std::string &name);
    void setTooltip(std::string_view tooltip);
    void setActive(bool isActive);
    void setHAlignment(CEnumComponentsGUI::EAlignmentHorizontal alignment);
    void setVAlignment(CEnumComponentsGUI::EAlignmentVertical alignment);
    void setBlinking(bool isBlinking);
    void setColorBlink(iv::types::color colorARGB);
    void setColorBackground(iv::types::color colorARGB);
    void setColorForeground(iv::types::color colorARGB);
    void setDefaultColorBlink();
    void setDefaultColorBackground();
    [[maybe_unused]] void setDefaultColorForeground();
    void setDefaultMinimum(iv::types::width sizeX, iv::types::height sizeY);
    void setDefaultWidthMaximum(iv::types::width sizeX);
    void setDefaultHeightMaximum(iv::types::height sizeY);
    void setVisible(bool isVisible);
    void setInactiveVisualFeedback(bool hasInactiveVisualFeedback);
 
    IWidget *getWidget() const;
    bool getBlinking();
 
    void updateColor();
 
protected:// inherited classes need access to their listeners to delete in method 'destroyWidget'
    std::vector<IListenerIsAccept *> *m_listenersIsAccept;
    std::vector<IListenerAccept *> *m_listenersAccept;
    std::vector<IListenerValidate *> *m_listenersValidate;
    std::vector<IListenerChange *> *m_listenersChange;
    std::vector<IListenerClose *> *m_listenersClose;
    std::vector<IListenerUpdate *> *m_listenersUpdate;
 
    const std::weak_ptr<IComponentsGUI> &m_frameRef {m_mutableFrameRef};
    std::weak_ptr<IComponentsGUI> m_mutableFrameRef;
 
private:
    struct SPrvTimerData
    {
        SPrvTimerData(uint64_t timeout, IListenerTimer **timer);
        ~SPrvTimerData();
 
        uint64_t m_timeout;
        IListenerTimer *m_timer;
    };
 
    virtual IWidget *createWidget(CDialog *dialogFatherRef) = 0;
    void prvProcessChangeRecursive(uint64_t recursiveLevel);
    virtual void prvProcessCloseChildren();
 
    std::string m_name;
    std::string m_tooltip;
    bool m_isVisible;
    bool m_isActive;
    bool m_hasInactiveVisualFeedback {true};
 
    CEnumComponentsGUI::EAlignmentHorizontal m_alignmentHorizontalComponent;
    CEnumComponentsGUI::EAlignmentVertical m_alignmentVerticalComponent;
 
    CAttrColorComp *m_attrColor;
 
    bool m_hasSizeMinimum;
    iv::types::width m_sizeXMinimum;
    iv::types::height m_sizeYMinimum;
 
    std::optional<iv::types::width> m_sizeXMaximum;
    std::optional<iv::types::height> m_sizeYMaximum;
 
    std::vector<std::shared_ptr<SPrvTimerData>> m_rcpTimers;
    std::vector<IDataPanel *> *m_dataPanels;
 
protected:
    AbstractComponentGUI *m_componentFatherRef;
 
    IWidget *m_widget;
 
    CDialog *m_dialogFatherRef;
};
 
#endif /* LIBS_GUI_ABSTRACTCOMPONENTGUI_HPP_ */