spk::Module::MouseModule Class Reference

Dispatches mouse events to a bound widget and tracks mouse state. More...

#include <spk_mouse_module.hpp>

Inheritance diagram for spk::Module::MouseModule:

Collaboration diagram for spk::Module::MouseModule:

Public Member Functions
spk::Mouse &	mouse ()
	Accesses the managed mouse state.
const spk::Mouse &	mouse () const
	Accesses the managed mouse state.
Public Member Functions inherited from spk::Module::EventBasedModule< spk::MouseEvent >
EventBasedModule &	operator= (const EventBasedModule &)=delete
void	setWidget (spk::Widget *p_widget)
	Binds the module to a widget that will receive callbacks.
spk::Widget *	widget () const
	Returns the currently bound widget.
void	insertEvent (spk::MouseEvent &&p_ievent)
	Queues a new event to be processed later.
bool	hasEvent () const
	Checks whether the module has pending events.
void	treatEvents ()
	Processes all queued events by invoking _treatEvent.

Protected Member Functions
void	_treatEvent (spk::MouseEvent &p_ievent) override
	Handles a single mouse event and forwards it to the widget.

Detailed Description

Dispatches mouse events to a bound widget and tracks mouse state.

See also

KeyboardModule, SystemModule

spk::Module::MouseModule mouse;
mouse.setWidget(&rootWidget);
// events are inserted externally then processed via treatEvents()

Member Function Documentation

_treatEvent()

void spk::Module::MouseModule::_treatEvent ( spk::MouseEvent & p_ievent )

overrideprotectedvirtual

Handles a single mouse event and forwards it to the widget.

Parameters

p_ievent

Event to treat.

Implements spk::Module::EventBasedModule< spk::MouseEvent >.

Here is the call graph for this function:

mouse() [1/2]

spk::Mouse & spk::Module::MouseModule::mouse

(

)

Accesses the managed mouse state.

Returns

Mutable mouse reference.

See also

mouse() const

mouse() [2/2]

const spk::Mouse & spk::Module::MouseModule::mouse

(

)

const

Accesses the managed mouse state.

Returns

Const mouse reference.

See also

mouse()

---

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

• includes/structure/application/module/spk_mouse_module.hpp
• srcs/structure/application/module/spk_mouse_module.cpp