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

CEGUI::MouseEventArgs Class Reference

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

#include <CEGUIInputEvent.h>

Inheritance diagram for CEGUI::MouseEventArgs:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MouseEventArgs (Window *wnd)

Public Attributes

Point position
 holds current mouse position.
Vector2 moveDelta
 holds variation of mouse position from last mouse input
MouseButton button
 one of the MouseButton enumerated values describing the mouse button causing the event (for button inputs only)
uint sysKeys
 current state of the system keys and mouse buttons.
float wheelChange
 Holds the amount the scroll wheel has changed.
uint clickCount
 Holds number of mouse button down events currently counted in a multi-click sequence (for button inputs only).
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 mouse input.

Definition at line 249 of file CEGUIInputEvent.h.


Constructor & Destructor Documentation

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

Definition at line 252 of file CEGUIInputEvent.h.


Member Data Documentation

MouseButton CEGUI::MouseEventArgs::button
 

one of the MouseButton enumerated values describing the mouse button causing the event (for button inputs only)

Definition at line 256 of file CEGUIInputEvent.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseWheelChange(), CEGUI::Window::onMouseButtonDown(), 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::MultiLineEditbox::onMouseTripleClicked(), and CEGUI::Editbox::onMouseTripleClicked().

uint CEGUI::MouseEventArgs::clickCount
 

Holds number of mouse button down events currently counted in a multi-click sequence (for button inputs only).

Definition at line 259 of file CEGUIInputEvent.h.

Referenced by CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), and CEGUI::System::injectMouseWheelChange().

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::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().

Vector2 CEGUI::MouseEventArgs::moveDelta
 

holds variation of mouse position from last mouse input

Definition at line 255 of file CEGUIInputEvent.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), and CEGUI::System::injectMouseWheelChange().

Point CEGUI::MouseEventArgs::position
 

holds current mouse position.

Definition at line 254 of file CEGUIInputEvent.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), 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::TabButton::onMouseButtonUp(), CEGUI::RadioButton::onMouseButtonUp(), CEGUI::PushButton::onMouseButtonUp(), CEGUI::MenuItem::onMouseButtonUp(), CEGUI::ComboDropList::onMouseButtonUp(), CEGUI::Checkbox::onMouseButtonUp(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::MultiLineEditbox::onMouseMove(), CEGUI::MenuItem::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::Listbox::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::Editbox::onMouseMove(), CEGUI::DragContainer::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), and CEGUI::ButtonBase::onMouseMove().

uint CEGUI::MouseEventArgs::sysKeys
 

current state of the system keys and mouse buttons.

Definition at line 257 of file CEGUIInputEvent.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::MultiColumnList::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), and CEGUI::ComboDropList::onMouseMove().

float CEGUI::MouseEventArgs::wheelChange
 

Holds the amount the scroll wheel has changed.

Definition at line 258 of file CEGUIInputEvent.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::StaticText::onMouseWheel(), CEGUI::Slider::onMouseWheel(), CEGUI::Scrollbar::onMouseWheel(), CEGUI::ScrollablePane::onMouseWheel(), CEGUI::MultiLineEditbox::onMouseWheel(), CEGUI::MultiColumnList::onMouseWheel(), and CEGUI::Listbox::onMouseWheel().

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

pointer to a Window object of relevance to the event.

Definition at line 240 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::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::Window::moveToFront_impl(), CEGUI::ScrolledContainer::onChildAdded(), CEGUI::ScrolledContainer::onChildRemoved(), and CEGUI::DragContainer::onDragDropTargetChanged().


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