tooltip.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef FIFEGUI_TOOLTIP_H
#define FIFEGUI_TOOLTIP_H
 
#include <functional>
#include <string>
 
// Platform config include (for FIFEGUI_API)
#include "fifechan/platform.hpp"
#include "fifechan/widgets/container.hpp"
 
namespace fcn
{

    enum class TooltipTrigger : uint8_t
    {
        Hover
    };

    enum class TooltipPlacement : uint8_t
    {
        Cursor,
        Right,
        Bottom
    };

    struct TooltipModifierBehavior
    {
            bool enabled = false;

            int modifier = 0x100; // KMOD_ALT from SDL

            std::function<std::string(int widgetId)> modifiedContent;
    };

    struct TooltipSpec
    {
            std::function<std::string(int widgetId)> content;

            int delayMs = 300;

            TooltipTrigger trigger = TooltipTrigger::Hover;

            TooltipPlacement placement = TooltipPlacement::Cursor;

            TooltipModifierBehavior modifierBehavior;
    };

    class FIFEGUI_API Tooltip : public Container
    {
        public:
            Tooltip();

            ~Tooltip() override = default;

            void setSpec(TooltipSpec const & spec);

            TooltipSpec const & getSpec() const;

            void setWidgetId(int id);

            int getWidgetId() const;

            void startHover();

            void endHover();

            bool isHovering() const;

            void update(int deltaMs, int modifierState);

            void generateContent();

            std::string const & getCurrentContent() const;

            bool isExtendedView() const;

            void draw(Graphics* graphics) override;

            Rectangle getChildrenArea() override;
 
        private:
            void generateNormalContent();
            void generateExtendedContent();
 
            TooltipSpec mSpec;
            int mWidgetId{0};
            bool mIsHovering{false};
            int mHoverTimer{0};
            int mModifierState{0};
 
            std::string mCurrentContent;
            bool mIsExtended{false};
    };
 
} // namespace fcn
 
#endif // FIFEGUI_TOOLTIP_H