om::gui::input::InputHandler Class Reference

An interface for objects that recieve user input events. More...

#include <omGUIInputHandler.h>

Inheritance diagram for om::gui::input::InputHandler:

Public Member Functions
virtual	~InputHandler ()
	Destroy an input handler. More...
virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI event that occured when this object had focus. More...
virtual Bool	textEvent (const TextEvent &event)
	Handle the specified text input event that occured when this object had focus. More...
virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event that occured when this object had focus. More...
virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event that occurred. More...
virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Handle the specified mouse motion event that occurred. More...
virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Handle the specified mouse wheel event that occurred. More...

Detailed Description

An interface for objects that recieve user input events.

Constructor & Destructor Documentation

virtual om::gui::input::InputHandler::~InputHandler ( )

virtual

Destroy an input handler.

Member Function Documentation

virtual Bool om::gui::input::InputHandler::guiEvent ( const GUIEvent &  event )

virtual

Handle the specified GUI event that occured when this object had focus.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, and om::graphics::gui::objects::GUIObjectWrapper.

virtual Bool om::gui::input::InputHandler::textEvent ( const TextEvent &  event )

virtual

Handle the specified text input event that occured when this object had focus.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, and om::graphics::gui::objects::GUIObjectWrapper.

virtual Bool om::gui::input::InputHandler::keyEvent ( const KeyEvent &  event )

virtual

Handle the specified keyboard event that occured when this object had focus.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::Button, om::graphics::gui::objects::GraphView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::Knob, om::graphics::gui::objects::Slider, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, om::graphics::gui::objects::GUIObjectWrapper, om::graphics::gui::objects::ColorPicker, and om::graphics::gui::objects::ColorField.

virtual Bool om::gui::input::InputHandler::mouseButtonEvent ( const MouseButtonEvent &  event )

virtual

Handle the specified mouse button event that occurred.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::Button, om::graphics::gui::objects::GraphView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::Slider, om::graphics::gui::objects::Knob, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::OptionMenu, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, om::graphics::gui::objects::GUIObjectWrapper, om::graphics::gui::objects::ColorPicker, and om::graphics::gui::objects::ColorField.

virtual Bool om::gui::input::InputHandler::mouseMotionEvent ( const MouseMotionEvent &  event )

virtual

Handle the specified mouse motion event that occurred.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::GraphView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::Knob, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::Slider, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, om::graphics::gui::objects::GUIObjectWrapper, and om::graphics::gui::objects::ColorPicker.

virtual Bool om::gui::input::InputHandler::mouseWheelEvent ( const MouseWheelEvent &  event )

virtual

Handle the specified mouse wheel event that occurred.

The method returns whether or not the event was handled by the input handler.

The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::GraphView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::TabView, om::graphics::gui::objects::Knob, om::graphics::gui::objects::Slider, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ScrollView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::RenderView, om::graphics::gui::objects::GUIObjectWrapper, and om::graphics::gui::objects::ColorPicker.

---

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

• omGUIInputHandler.h