FifeGUI 0.2.0
A C++ GUI library designed for games.
mouselistener.hpp
1// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
2// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
3// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
4
5#ifndef INCLUDE_FIFECHAN_MOUSELISTENER_HPP_
6#define INCLUDE_FIFECHAN_MOUSELISTENER_HPP_
7
8#include "fifechan/mouseevent.hpp"
9#include "fifechan/platform.hpp"
10
11namespace fcn
12{
20 class FIFEGUI_API MouseListener
21 {
22 public:
23 virtual ~MouseListener() = default;
24
25 MouseListener(MouseListener const &) = default;
26 MouseListener& operator=(MouseListener const &) = default;
27 MouseListener(MouseListener&&) = default;
28 MouseListener& operator=(MouseListener&&) = default;
29
35 virtual void mouseEntered(MouseEvent& mouseEvent) { }
36
42 virtual void mouseExited(MouseEvent& mouseEvent) { }
43
52 virtual void mousePressed(MouseEvent& mouseEvent) { }
53
59 virtual void mouseReleased(MouseEvent& mouseEvent) { }
60
67 virtual void mouseClicked(MouseEvent& mouseEvent) { }
68
74 virtual void mouseWheelMovedUp(MouseEvent& mouseEvent) { }
75
81 virtual void mouseWheelMovedDown(MouseEvent& mouseEvent) { }
82
88 virtual void mouseWheelMovedRight(MouseEvent& mouseEvent) { }
89
95 virtual void mouseWheelMovedLeft(MouseEvent& mouseEvent) { }
96
103 virtual void mouseMoved(MouseEvent& mouseEvent) { }
104
111 virtual void mouseDragged(MouseEvent& mouseEvent) { }
112
113 protected:
120 MouseListener() = default;
121 };
122} // namespace fcn
123
124#endif // INCLUDE_FIFECHAN_MOUSELISTENER_HPP_
Represents a mouse event.
virtual void mouseClicked(MouseEvent &mouseEvent)
Called when a mouse button is pressed and released (clicked) on the widget area.
virtual void mouseWheelMovedDown(MouseEvent &mouseEvent)
Called when the mouse wheel has moved down on the widget area.
virtual void mouseDragged(MouseEvent &mouseEvent)
Called when the mouse has moved and the mouse has previously been pressed on the widget.
virtual void mouseEntered(MouseEvent &mouseEvent)
Called when the mouse has entered into the widget area.
virtual void mouseWheelMovedRight(MouseEvent &mouseEvent)
Called when the mouse wheel has moved right on the widget area.
virtual void mouseMoved(MouseEvent &mouseEvent)
Called when the mouse has moved in the widget area and no mouse button has been pressed (i....
virtual void mousePressed(MouseEvent &mouseEvent)
Called when a mouse button has been pressed on the widget area.
virtual void mouseWheelMovedLeft(MouseEvent &mouseEvent)
Called when the mouse wheel has moved left on the widget area.
MouseListener()=default
Constructor.
virtual void mouseExited(MouseEvent &mouseEvent)
Called when the mouse has exited the widget area.
virtual void mouseReleased(MouseEvent &mouseEvent)
Called when a mouse button has been released on the widget area.
virtual void mouseWheelMovedUp(MouseEvent &mouseEvent)
Called when the mouse wheel has moved up on the widget area.