focushandler.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_FOCUSHANDLER_HPP_
#define INCLUDE_FIFECHAN_FOCUSHANDLER_HPP_
 
#include <vector>
 
#include "fifechan/event.hpp"
#include "fifechan/platform.hpp"
 
namespace fcn
{
    class Widget;

    class FIFEGUI_API FocusHandler
    {
    public:
        virtual ~FocusHandler() = default;
        FocusHandler();
 
        FocusHandler(FocusHandler const &)            = delete;
        FocusHandler& operator=(FocusHandler const &) = delete;
        FocusHandler(FocusHandler&&)                  = delete;
        FocusHandler& operator=(FocusHandler&&)       = delete;

        virtual void requestFocus(Widget* widget);

        virtual void requestModalFocus(Widget* widget);

        virtual void requestModalMouseInputFocus(Widget* widget);

        virtual void releaseModalFocus(Widget* widget);

        virtual void releaseModalMouseInputFocus(Widget* widget);

        virtual bool isFocused(Widget const * widget) const;

        virtual Widget* getFocused() const;

        virtual Widget* getModalFocused() const;

        virtual Widget* getModalMouseInputFocused() const;

        virtual void focusNext();

        virtual void focusPrevious();

        virtual void add(Widget* widget);

        virtual void remove(Widget* widget);

        virtual void focusNone();

        virtual void tabNext();

        virtual void tabPrevious();

        virtual Widget* getDraggedWidget();

        virtual void setDraggedWidget(Widget* draggedWidget);

        virtual Widget* getLastWidgetWithMouse();

        virtual void setLastWidgetWithMouse(Widget* lastWidgetWithMouse);

        virtual Widget* getLastWidgetWithModalFocus();

        virtual void setLastWidgetWithModalFocus(Widget* lastWidgetWithModalFocus);

        virtual Widget* getLastWidgetWithModalMouseInputFocus();

        virtual void setLastWidgetWithModalMouseInputFocus(Widget* lastWidgetWithModalMouseInputFocus);

        virtual Widget* getLastWidgetPressed();

        virtual void setLastWidgetPressed(Widget* lastWidgetPressed);

        virtual void widgetHidden(Widget* widget);
 
    protected:
        virtual void distributeFocusLostEvent(Event const & focusEvent);

        virtual void distributeFocusGainedEvent(Event const & focusEvent);

        using WidgetVector = std::vector<Widget*>;

        using WidgetIterator = WidgetVector::iterator;

        WidgetVector mWidgets;

        Widget* mFocusedWidget;

        Widget* mModalFocusedWidget;

        Widget* mModalMouseInputFocusedWidget;

        Widget* mDraggedWidget;

        Widget* mLastWidgetWithMouse;

        Widget* mLastWidgetWithModalFocus;

        Widget* mLastWidgetWithModalMouseInputFocus;

        Widget* mLastWidgetPressed;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_FOCUSHANDLER_HPP_