OpenGUI::Input_EventArgs Class Reference

#include <OpenGUI_Event.h>

Inheritance diagram for OpenGUI::Input_EventArgs:

Detailed Description

Base class for input related events.

The purpose of this class is to ensure a standard interface for signaling input consumption.

Public Member Functions

void eat ()

consume this input event

Public Attributes

const bool Consumed

Ready only member for getting the current consumption state of this event.

Member Function Documentation

void OpenGUI::Input_EventArgs::eat ( ) [inline]

consume this input event

This does not necessarily prevent the event from continuing its propagation, it merely marks it as having been used somewhere, so that the input injection routine that created it will return true, rather than false.

Member Data Documentation

const bool OpenGUI::Input_EventArgs::Consumed

Ready only member for getting the current consumption state of this event.

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

OpenGUI_Event.h


Public Member Functions
void	eat ()
	consume this input event
Public Attributes
const bool	Consumed
	Ready only member for getting the current consumption state of this event.