CEGUI::EventArgs Class Reference

Base class used as the argument to all subscribers Event object. More...

Inherits CEGUI::AllocatedObject< EventArgs >.

Inherited by CEGUI::AnimationEventArgs, CEGUI::DisplayEventArgs, CEGUI::ElementEventArgs, CEGUI::FontEventArgs, CEGUI::GUIContextEventArgs, CEGUI::LinkedEventArgs, CEGUI::MouseCursorEventArgs, CEGUI::NamedElementEventArgs, CEGUI::RenderQueueEventArgs, CEGUI::RenderTargetEventArgs, CEGUI::ResourceEventArgs, and CEGUI::WindowEventArgs.

Collaboration diagram for CEGUI::EventArgs:

Public Attributes
uint	handled
	handlers should increment this if they handled the event.

Detailed Description

Base class used as the argument to all subscribers Event object.

The base EventArgs class does not contain any useful information, it is intended to be specialised for each type of event that can be generated by objects within the system. The use of this base class allows all event subscribers to have the same function signature.

The handled field is used to signal whether an event was actually handled or not. While the event system does not look at this value, code at a higher level can use it to determine how far to propagate an event.