#include <inputguievent.h>

Inheritance diagram for InputGuiEvent:

Public Member Functions
	InputGuiEvent (Widget *const source)

void	consume ()

bool	isConsumed () const

Public Member Functions inherited from Event
	Event (Widget *const source)

virtual	~Event ()

Widget *	getSource () const

Protected Attributes
bool	mIsConsumed

Protected Attributes inherited from Event
Widget *	mSource

Detailed Description

Base class for all events concerning input.

Author: Olof Naessén

Definition at line 75 of file inputguievent.h.

Constructor & Destructor Documentation

◆ InputGuiEvent()

InputGuiEvent::InputGuiEvent ( Widget *const source )

inlineexplicit

Constructor.

Parameters

source The source widget of the event.

Definition at line 83 of file inputguievent.h.

                                                      :
             Event(source),
             mIsConsumed(false)
         { }

Member Function Documentation

◆ consume()

void InputGuiEvent::consume ( )

inline

Marks the event as consumed. Input event listeners may discard consumed input or act on consumed input. An example of a widget that discards consumed input is the ScrollArea widget that discards consumed mouse wheel events so the ScrollArea will not scroll if for instance a Slider's value inside the ScrollArea was changed with the mouse wheel.

See also: isConsumed

Definition at line 100 of file inputguievent.h.

101 { mIsConsumed = true; }

References mIsConsumed.

◆ isConsumed()

bool InputGuiEvent::isConsumed ( ) const

inline

Checks if the input event is consumed.

Returns: True if the input event is consumed, false otherwise.

See also: consume

Definition at line 110 of file inputguievent.h.

111 { return mIsConsumed; }

References mIsConsumed.

Referenced by Gui::distributeKeyEventToGlobalKeyListeners(), Gui::distributeMouseEvent(), Gui::handleKeyInput(), DropDown::keyPressed(), TabbedArea::keyPressed(), EditServerDialog::keyPressed(), LoginDialog::keyPressed(), RegisterDialog::keyPressed(), ServerDialog::keyPressed(), Window::mouseDragged(), ChatWindow::mouseDragged(), ShortcutWindow::mouseDragged(), Viewport::mouseDragged(), Window::mouseMoved(), ScrollArea::mousePressed(), TabbedArea::mousePressed(), Window::mousePressed(), ChatWindow::mousePressed(), ShortcutWindow::mousePressed(), Viewport::mousePressed(), ScrollArea::mouseReleased(), Viewport::mouseReleased(), ScrollArea::mouseWheelMovedDown(), and ScrollArea::mouseWheelMovedUp().

Field Documentation

◆ mIsConsumed

bool InputGuiEvent::mIsConsumed

protected

True if the input event is consumed, false otherwise.

Definition at line 118 of file inputguievent.h.

Referenced by consume(), and isConsumed().

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

src/events/inputguievent.h (986a3bf)

Public Member Functions

Protected Attributes