WindowEvent.ixx File

Abstract base class for window-related events. More...

Included Headers

#include <cstdint> #include <helios.event.Event> #include <helios.util.Guid>

Namespaces Index

namespace	helios
namespace	window
	Window management and configuration. More...
namespace	event
	Window event definitions. More...

Classes Index

class	WindowEvent
	Abstract base class for Window related events. More...

Description

Abstract base class for window-related events.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file WindowEvent.ixx

3 * @brief Abstract base class for window-related events.

4 */

5module;

6

7#include <cstdint>

8

9export module helios.window.event.WindowEvent;

10

11import helios.util.Guid;

12import helios.event.Event;

13

14export namespace helios::window::event {

15

16 /**

17 * @brief Abstract base class for Window related events.

18 *

19 * The WindowEvent extends the Event-base class by adding a unique

20 * sourceGuid, so the source of the event can be identified.

21 */

22 class WindowEvent : public helios::event::Event {

23

24 protected:

25 /**

26 * @brief Constructs a new WindowEvent with the specific source Guid.

27 *

28 * @param sourceGuid The Guid of the Window that triggered the event.

29 */

30 explicit WindowEvent(helios::util::Guid sourceGuid):

31 sourceGuid(sourceGuid) {}

32

33 /**

34 * @brief Constructs a new WindowEvent with the specific source Guid and

35 * the specific tag.

36 *

37 * @param sourceGuid The Guid of the Window that triggered the event.

38 * @param tag A `uint64_t` value identifying the specific type of event.

39 */

40 explicit WindowEvent(helios::util::Guid sourceGuid, uint64_t tag):

41 Event(tag), sourceGuid(sourceGuid) {}

42

43 public:

44

45 /**

46 * @brief The unique and immutable Guid of the source of this event, i.e.

47 * the Window that trigegred the event.

48 */

49 const helios::util::Guid sourceGuid;

50

51 };

52

53}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.