Ajax::ScreenMgr::DisplayApi Class Reference

This class defines the Screen Manager's interface to Graphic library. More...

Detailed Description

This class defines the Screen Manager's interface to Graphic library.

Only functionality required by the Screen Manager is defined. The expectation is that individual Screen instances directly access/use the Graphic library.

#include <DisplayApi.h>

Inheritance diagram for Ajax::ScreenMgr::DisplayApi:

Public Member Functions
virtual bool	start () noexcept=0
	This method is used to initialize/start the Graphics library.
virtual void	stop () noexcept=0
	This method is used to shutdown/stop the Graphics library.
virtual bool	update () noexcept=0
	This method requests that the Graphic library physically update the display.
virtual bool	turnOff () noexcept=0
	This method requests that the display is 'turned off'.
virtual bool	turnOn () noexcept=0
	This method restore the 'on' state after a previous call to turnOff().
virtual	~DisplayApi ()
	Virtual destructor.

Constructor & Destructor Documentation

~DisplayApi()

virtual Ajax::ScreenMgr::DisplayApi::~DisplayApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

start()

virtual bool Ajax::ScreenMgr::DisplayApi::start ( )

pure virtualnoexcept

This method is used to initialize/start the Graphics library.

Returns false if an UNRECOVERABLE error occurred; else true is returned.

Implemented in Ajax::Ui::PicoDisplay.

stop()

virtual void Ajax::ScreenMgr::DisplayApi::stop ( )

pure virtualnoexcept

This method is used to shutdown/stop the Graphics library.

Implemented in Ajax::Ui::PicoDisplay.

turnOff()

virtual bool Ajax::ScreenMgr::DisplayApi::turnOff ( )

pure virtualnoexcept

This method requests that the display is 'turned off'.

What 'off' means is application/library/platform specific. Returns false if an UNRECOVERABLE error occurred; else true is returned.

Implemented in Ajax::Ui::PicoDisplay.

turnOn()

virtual bool Ajax::ScreenMgr::DisplayApi::turnOn ( )

pure virtualnoexcept

This method restore the 'on' state after a previous call to turnOff().

Returns false if an UNRECOVERABLE error occurred; else true is returned.

Implemented in Ajax::Ui::PicoDisplay.

update()

virtual bool Ajax::ScreenMgr::DisplayApi::update ( )

pure virtualnoexcept

This method requests that the Graphic library physically update the display.

Returns false if an UNRECOVERABLE error occurred; else true is returned.

Implemented in Ajax::Ui::PicoDisplay.

---

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

• Ajax/ScreenMgr/DisplayApi.h