mouseevent.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_MOUSEEVENT_HPP_
#define INCLUDE_FIFECHAN_MOUSEEVENT_HPP_
 
// Standard library includes
#include <cstdint>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/events/inputevent.hpp"
 
namespace fcn
{
    class Gui;
    class Widget;

    class FIFEGUI_API MouseEvent : public InputEvent
    {
        public:
            enum class Type : std::uint8_t
            {
                Moved = 0,
                Pressed,
                Released,
                WheelMovedDown,
                WheelMovedUp,
                WheelMovedRight,
                WheelMovedLeft,
                Clicked,
                Entered,
                Exited,
                Dragged
            };

            enum class Button : std::uint8_t
            {
                Empty = 0,
                Left,
                Middle,
                Right,
                X1,
                X2
            };

            MouseEvent(
                Widget* source,
                Widget* distributor,
                bool isShiftPressed,
                bool isControlPressed,
                bool isAltPressed,
                bool isMetaPressed,
                MouseEvent::Type type,
                MouseEvent::Button button,
                int x,
                int y,
                int clickCount);

            MouseEvent::Button getButton() const;

            int getX() const;

            int getY() const;

            int getClickCount() const;

            MouseEvent::Type getType() const;
 
        protected:
            MouseEvent::Type mType;

            MouseEvent::Button mButton;

            int mX = 0;

            int mY = 0;

            int mClickCount;

            friend class Gui;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_MOUSEEVENT_HPP_