Mezzanine::EventQuit Class Reference

This is intended to convey the message that quitting needs to happen. More...

#include <eventquit.h>

Inheritance diagram for Mezzanine::EventQuit:

Collaboration diagram for Mezzanine::EventQuit:

Public Member Functions
virtual EventType	GetType () const
	This returns EventType::QuitMessage. More...
Public Member Functions inherited from Mezzanine::EventBase
virtual	~EventBase ()
	Virtual Deconstructor.

Additional Inherited Members
Public Types inherited from Mezzanine::EventBase
enum	EventType { GameWindow, QuitMessage, UserInput, Other }

Detailed Description

This is intended to convey the message that quitting needs to happen.

This stores not data other than the fact that this is a Quit event. This means that either an underlying system like the OS or a service has requested a quit, or the application has manually put a quit message in the queue to signal that a graceful shutdown needs to occur.

Definition at line 63 of file eventquit.h.

Member Function Documentation

EventBase::EventType Mezzanine::EventQuit::GetType ( ) const

virtual

This returns EventType::QuitMessage.

This returns the kind of message this is, specifcally EventType::QuitMessage . If this functions returns EventType::QuitMessage, then and event pointer can safely be cast to Mezzanine::EventQuit . This method is inherited from Mezzanine::Event .

Implements Mezzanine::EventBase.

Definition at line 52 of file eventquit.cpp.

---

The documentation for this class was generated from the following files:

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/eventquit.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/eventquit.cpp