Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::EventArgs Class Reference

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

#include <CEGUIEventArgs.h>

Inheritance diagram for CEGUI::EventArgs:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 EventArgs (void)
virtual ~EventArgs (void)

Public Attributes

bool handled
 handlers should set this to true if they handled the event, or false otherwise.

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.

Definition at line 48 of file CEGUIEventArgs.h.


Constructor & Destructor Documentation

CEGUI::EventArgs::EventArgs void   )  [inline]
 

Definition at line 54 of file CEGUIEventArgs.h.

virtual CEGUI::EventArgs::~EventArgs void   )  [inline, virtual]
 

Definition at line 55 of file CEGUIEventArgs.h.


Member Data Documentation

bool CEGUI::EventArgs::handled
 

handlers should set this to true if they handled the event, or false otherwise.

Definition at line 61 of file CEGUIEventArgs.h.

Referenced by CEGUI::ScrollablePane::handleAutoSizePaneChanged(), CEGUI::System::injectChar(), CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::Window::moveToFront_impl(), CEGUI::StaticImage::onAlphaChanged(), CEGUI::Static::onAlphaChanged(), CEGUI::MultiLineEditbox::onCaptureLost(), CEGUI::MenuItem::onCaptureLost(), CEGUI::ListHeaderSegment::onCaptureLost(), CEGUI::FrameWindow::onCaptureLost(), CEGUI::Editbox::onCaptureLost(), CEGUI::DragContainer::onCaptureLost(), CEGUI::ComboDropList::onCaptureLost(), CEGUI::ButtonBase::onCaptureLost(), CEGUI::MultiLineEditbox::onCharacter(), CEGUI::Editbox::onCharacter(), CEGUI::MultiLineEditbox::onKeyDown(), CEGUI::Editbox::onKeyDown(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::Thumb::onMouseButtonDown(), CEGUI::Slider::onMouseButtonDown(), CEGUI::Scrollbar::onMouseButtonDown(), CEGUI::MultiLineEditbox::onMouseButtonDown(), CEGUI::MultiColumnList::onMouseButtonDown(), CEGUI::MenuItem::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Editbox::onMouseButtonDown(), CEGUI::DragContainer::onMouseButtonDown(), CEGUI::ComboDropList::onMouseButtonDown(), CEGUI::ButtonBase::onMouseButtonDown(), CEGUI::Titlebar::onMouseButtonUp(), CEGUI::TabButton::onMouseButtonUp(), CEGUI::RadioButton::onMouseButtonUp(), CEGUI::PushButton::onMouseButtonUp(), CEGUI::MultiLineEditbox::onMouseButtonUp(), CEGUI::MenuItem::onMouseButtonUp(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::FrameWindow::onMouseButtonUp(), CEGUI::Editbox::onMouseButtonUp(), CEGUI::DragContainer::onMouseButtonUp(), CEGUI::ComboDropList::onMouseButtonUp(), CEGUI::Checkbox::onMouseButtonUp(), CEGUI::ButtonBase::onMouseButtonUp(), CEGUI::Titlebar::onMouseDoubleClicked(), CEGUI::MultiLineEditbox::onMouseDoubleClicked(), CEGUI::ListHeaderSegment::onMouseDoubleClicked(), CEGUI::Editbox::onMouseDoubleClicked(), CEGUI::MenuItem::onMouseLeaves(), CEGUI::ButtonBase::onMouseLeaves(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::MultiLineEditbox::onMouseMove(), CEGUI::MenuItem::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::Editbox::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), CEGUI::ButtonBase::onMouseMove(), CEGUI::MultiLineEditbox::onMouseTripleClicked(), CEGUI::Editbox::onMouseTripleClicked(), CEGUI::StaticText::onMouseWheel(), CEGUI::Slider::onMouseWheel(), CEGUI::Scrollbar::onMouseWheel(), CEGUI::ScrollablePane::onMouseWheel(), CEGUI::MultiLineEditbox::onMouseWheel(), CEGUI::MultiColumnList::onMouseWheel(), CEGUI::Listbox::onMouseWheel(), CEGUI::StaticImage::onSized(), CEGUI::Static::onSized(), CEGUI::ScrollablePane::onSized(), CEGUI::PushButton::onSized(), CEGUI::MultiLineEditbox::onSized(), CEGUI::MultiColumnList::onSized(), CEGUI::Listbox::onSized(), CEGUI::ItemListBase::onSized(), CEGUI::StaticImage::onStaticFrameChanged(), CEGUI::TextItem::onTextChanged(), CEGUI::Spinner::onTextChanged(), CEGUI::MultiLineEditbox::onTextChanged(), CEGUI::Editbox::onTextChanged(), CEGUI::Combobox::onTextChanged(), CEGUI::Event::operator()(), and CEGUI::Window::setInheritsAlpha().


The documentation for this class was generated from the following file:
Generated on Wed Sep 7 10:05:52 2005 for Crazy Eddies GUI System by  doxygen 1.4.3