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

CEGUI::KeyEventArgs Class Reference

EventArgs based class that is used for objects passed to input event handlers concerning keyboard input. More...

#include <CEGUIInputEvent.h>

Inheritance diagram for CEGUI::KeyEventArgs:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::KeyEventArgs:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KeyEventArgs (Window *wnd)

Public Attributes

utf32 codepoint
 utf32 codepoint for the key (only used for Character inputs).
Key::Scan scancode
 Scan code of key that caused event (only used for key up & down inputs.
uint sysKeys
 current state of the system keys and mouse buttons.
Windowwindow
 pointer to a Window object of relevance to the event.
bool handled
 handlers should set this to true if they handled the event, or false otherwise.

Detailed Description

EventArgs based class that is used for objects passed to input event handlers concerning keyboard input.

Definition at line 280 of file CEGUIInputEvent.h.


Constructor & Destructor Documentation

CEGUI::KeyEventArgs::KeyEventArgs Window wnd  )  [inline]
 

Definition at line 283 of file CEGUIInputEvent.h.


Member Data Documentation

utf32 CEGUI::KeyEventArgs::codepoint
 

utf32 codepoint for the key (only used for Character inputs).

Definition at line 285 of file CEGUIInputEvent.h.

Referenced by CEGUI::System::injectChar(), CEGUI::MultiLineEditbox::onCharacter(), and CEGUI::Editbox::onCharacter().

bool CEGUI::EventArgs::handled [inherited]
 

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::System::injectChar(), CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::StaticImage::onAlphaChanged(), CEGUI::Static::onAlphaChanged(), CEGUI::MultiLineEditbox::onCaptureLost(), CEGUI::ListHeaderSegment::onCaptureLost(), CEGUI::FrameWindow::onCaptureLost(), CEGUI::Editbox::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::ListHeaderSegment::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Editbox::onMouseButtonDown(), CEGUI::ComboDropList::onMouseButtonDown(), CEGUI::ButtonBase::onMouseButtonDown(), CEGUI::Titlebar::onMouseButtonUp(), CEGUI::TabButton::onMouseButtonUp(), CEGUI::RadioButton::onMouseButtonUp(), CEGUI::PushButton::onMouseButtonUp(), CEGUI::MultiLineEditbox::onMouseButtonUp(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::FrameWindow::onMouseButtonUp(), CEGUI::Editbox::onMouseButtonUp(), CEGUI::ComboDropList::onMouseButtonUp(), CEGUI::Checkbox::onMouseButtonUp(), CEGUI::ButtonBase::onMouseButtonUp(), CEGUI::Titlebar::onMouseDoubleClicked(), CEGUI::MultiLineEditbox::onMouseDoubleClicked(), CEGUI::ListHeaderSegment::onMouseDoubleClicked(), CEGUI::Editbox::onMouseDoubleClicked(), CEGUI::ButtonBase::onMouseLeaves(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::MultiLineEditbox::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::MultiLineEditbox::onMouseWheel(), CEGUI::MultiColumnList::onMouseWheel(), CEGUI::Listbox::onMouseWheel(), CEGUI::TabControl::onSized(), CEGUI::StaticImage::onSized(), CEGUI::Static::onSized(), CEGUI::Slider::onSized(), CEGUI::Scrollbar::onSized(), CEGUI::MultiLineEditbox::onSized(), CEGUI::MultiColumnList::onSized(), CEGUI::Listbox::onSized(), CEGUI::Combobox::onSized(), CEGUI::StaticImage::onStaticFrameChanged(), CEGUI::MultiLineEditbox::onTextChanged(), CEGUI::Editbox::onTextChanged(), CEGUI::Combobox::onTextChanged(), CEGUI::Event::operator()(), and CEGUI::Window::setInheritsAlpha().

Key::Scan CEGUI::KeyEventArgs::scancode
 

Scan code of key that caused event (only used for key up & down inputs.

Definition at line 286 of file CEGUIInputEvent.h.

Referenced by CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::MultiLineEditbox::onKeyDown(), and CEGUI::Editbox::onKeyDown().

uint CEGUI::KeyEventArgs::sysKeys
 

current state of the system keys and mouse buttons.

Definition at line 287 of file CEGUIInputEvent.h.

Referenced by CEGUI::System::injectChar(), CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::MultiLineEditbox::onKeyDown(), and CEGUI::Editbox::onKeyDown().

Window* CEGUI::WindowEventArgs::window [inherited]
 

pointer to a Window object of relevance to the event.

Definition at line 238 of file CEGUIInputEvent.h.

Referenced by CEGUI::TabControl::handleContentWindowTextChanged(), CEGUI::TabControl::handleTabButtonClicked(), CEGUI::System::injectChar(), CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseMove(), and CEGUI::System::injectMouseWheelChange().


The documentation for this class was generated from the following file:
Generated on Wed Feb 16 12:41:10 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1