Skip to main content

Controller Class

Abstract base class for application controllers. More...

Declaration

class helios::app::controller::Controller { ... }

Derived Classes

classWindowRenderingController

Abstract base controller for handling window related events. More...

Public Destructor Index

~Controller ()=default

Public Member Functions Index

voidsubscribeTo (helios::event::Dispatcher &dispatcher)=0

Registers this controller with the specified Dispatcher. More...

boolinit ()=0

Initializes this controller. More...

std::stringtoString () const noexcept=0

Description

Abstract base class for application controllers.

Derived classes are expected to implement methods for event subscription/handling and optional initialization.

Definition at line 20 of file Controller.ixx.

Public Destructor

~Controller()

virtual helios::app::controller::Controller::~Controller ()
virtual default

Definition at line 22 of file Controller.ixx.

Public Member Functions

init()

virtual bool helios::app::controller::Controller::init ()

Initializes this controller.

The initialization state is defined by deriving classes.

Returns

bool true if the controller was successfully initialized and is in a valid state, otherwise false, signaling this controller should not be used further.

Definition at line 42 of file Controller.ixx.

subscribeTo()

virtual void helios::app::controller::Controller::subscribeTo (helios::event::Dispatcher & dispatcher)

Registers this controller with the specified Dispatcher.

This method should be called whenever a controller is interested in abn event dispatched by the specified Dispatcher.

Parameters
dispatcher

Definition at line 32 of file Controller.ixx.

toString()

virtual std::string helios::app::controller::Controller::toString ()
nodiscard noexcept

Definition at line 44 of file Controller.ixx.


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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.