Sparkle 0.0.1
Loading...
Searching...
No Matches
spk::Module::SystemModule Class Referencefinal

Handles system-level events (creation, resize, quit) for the application and its widget tree. More...

#include <spk_system_module.hpp>

Inheritance diagram for spk::Module::SystemModule:
Inheritance graph
Collaboration diagram for spk::Module::SystemModule:
Collaboration graph

Public Member Functions

void setApplication (GraphicalApplication *p_application)
 Associates the module with an application instance.
Public Member Functions inherited from spk::Module::EventBasedModule< spk::SystemEvent >
EventBasedModuleoperator= (const EventBasedModule &)=delete
void setWidget (spk::Widget *p_widget)
 Binds the module to a widget that will receive callbacks.
spk::Widgetwidget () const
 Returns the currently bound widget.
void insertEvent (spk::SystemEvent &&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::SystemEvent &p_ievent) override
 Applies a system event to the application.

Detailed Description

Handles system-level events (creation, resize, quit) for the application and its widget tree.

See also
GraphicalApplication, EventBasedModule

Member Function Documentation

◆ _treatEvent()

void spk::Module::SystemModule::_treatEvent ( spk::SystemEvent & p_ievent)
overrideprotectedvirtual

Applies a system event to the application.

Parameters
p_ieventSystem event to handle.

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

Here is the call graph for this function:

◆ setApplication()

void spk::Module::SystemModule::setApplication ( GraphicalApplication * p_application)

Associates the module with an application instance.

Parameters
p_applicationTarget application; may be null to detach.

The documentation for this class was generated from the following files:
  • includes/structure/application/module/spk_system_module.hpp
  • srcs/structure/application/module/spk_system_module.cpp