CoreGraphics::DisplayEventHandler Class Reference

#include <displayeventhandler.h>

Detailed Description

A display event handler object is notified by the DisplayDevice about noteworthy window events, for instance when the mouse is moved, the window is minimized, and so on.

To get notified about those events, derive a class from DisplayEventHandler and attach to the display device via DisplayDevice::AttachEventHandler().

Copyright

(C) 2007 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Inherited by CoreGraphics::ThreadSafeDisplayEventHandler, GLFW::GLFWGraphicsDisplayEventHandler, and GLFW::GLFWInputDisplayEventHandler.

Public Member Functions
	DisplayEventHandler ()
	constructor
virtual	~DisplayEventHandler ()
	destructor
virtual void	OnAttach ()
	called when the event handler is attached to the DisplayDevice
virtual void	OnRemove ()
	called when the event handler is removed from the DisplayDevice
virtual bool	PutEvent (const DisplayEvent &event)
	called by DisplayDevice when an event happens
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Protected Member Functions
virtual bool	HandleEvent (const DisplayEvent &event)
	called when an event should be processed, override this method in your subclass
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Private Member Functions
	__DeclareClass (DisplayEventHandler)

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)

Constructor & Destructor Documentation

DisplayEventHandler()

CoreGraphics::DisplayEventHandler::DisplayEventHandler

(

)

constructor

~DisplayEventHandler()

CoreGraphics::DisplayEventHandler::~DisplayEventHandler ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

CoreGraphics::DisplayEventHandler::__DeclareClass ( DisplayEventHandler )

private

HandleEvent()

bool CoreGraphics::DisplayEventHandler::HandleEvent ( const DisplayEvent & e )

protectedvirtual

called when an event should be processed, override this method in your subclass

Handle a display event.

This method is usually called by PutEvent(), but subclasses of DisplayEventHandler may choose to implement a different behaviour. Override this method in your subclass to process the incoming event.

Reimplemented in CoreGraphics::ThreadSafeDisplayEventHandler, GLFW::GLFWGraphicsDisplayEventHandler, and GLFW::GLFWInputDisplayEventHandler.

OnAttach()

void CoreGraphics::DisplayEventHandler::OnAttach ( )

virtual

called when the event handler is attached to the DisplayDevice

OnRemove()

void CoreGraphics::DisplayEventHandler::OnRemove ( )

virtual

called when the event handler is removed from the DisplayDevice

PutEvent()

bool CoreGraphics::DisplayEventHandler::PutEvent ( const DisplayEvent & e )

virtual

called by DisplayDevice when an event happens

This method is called by the DisplayDevice when an event happens.

The default behaviour of this class is to call the HandleEvent() method directly. Subclasses of DisplayEventHandler may choose to implement a different behaviour.

Reimplemented in CoreGraphics::ThreadSafeDisplayEventHandler.

---

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

• /github/workspace/code/render/coregraphics/displayeventhandler.h
• /github/workspace/code/render/coregraphics/displayeventhandler.cc