Ajax::ScreenMgr::Navigation Class Reference

This class defines the interface - used by ScreenApi instances - to navigate to other screen instances. More...

Detailed Description

This class defines the interface - used by ScreenApi instances - to navigate to other screen instances.

#include <Navigation.h>

Inheritance diagram for Ajax::ScreenMgr::Navigation:

Public Member Functions
virtual void	push (ScreenApi &newScreen) noexcept=0
	This method pushes the current active screen onto the navigation stack and makes the specified screen the active screen.
virtual void	pop (unsigned count=1) noexcept=0
	This method pops N-instances off of the navigation stack and make the last popped instance the current active screen.
virtual void	popTo (ScreenApi &returnToScreen) noexcept=0
	This method is similar to pop(), except is pops screen instances till there is match for 'returnToScreen'.
virtual void	popToHome () noexcept=0
	This method clears the navigation stack and make the Home screen the active screen.
virtual ScreenApi *	getCurrentScreen () noexcept=0
	Returns a pointer to the current screen.
virtual bool	isCurrentScreenHaltError () noexcept=0
	This method returns true ONLY when the 'Halt-Error-Screen' is displayed.
virtual	~Navigation ()
	Virtual destructor.

Constructor & Destructor Documentation

~Navigation()

virtual Ajax::ScreenMgr::Navigation::~Navigation ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

getCurrentScreen()

virtual ScreenApi * Ajax::ScreenMgr::Navigation::getCurrentScreen ( )

pure virtualnoexcept

Returns a pointer to the current screen.

If there is no current screen (e.g. still displaying the splash screen), then nullptr is returned.

Implemented in Ajax::ScreenMgr::Api.

isCurrentScreenHaltError()

virtual bool Ajax::ScreenMgr::Navigation::isCurrentScreenHaltError ( )

pure virtualnoexcept

This method returns true ONLY when the 'Halt-Error-Screen' is displayed.

Implemented in Ajax::ScreenMgr::Api.

pop()

virtual void Ajax::ScreenMgr::Navigation::pop ( unsigned  count = 1 )

pure virtualnoexcept

This method pops N-instances off of the navigation stack and make the last popped instance the current active screen.

If N exceeds the number of items on the stack, the Screen Manager 'logs an error' and the Home screen is made the active screen.

Implemented in Ajax::ScreenMgr::Api.

popTo()

virtual void Ajax::ScreenMgr::Navigation::popTo ( ScreenApi &  returnToScreen )

pure virtualnoexcept

This method is similar to pop(), except is pops screen instances till there is match for 'returnToScreen'.

If the match is found, then 'returnToScreen' is made the current active screen. If no match is found, the Screen Manager 'logs an error' and the Home screen is made the active screen.

Implemented in Ajax::ScreenMgr::Api.

popToHome()

virtual void Ajax::ScreenMgr::Navigation::popToHome ( )

pure virtualnoexcept

This method clears the navigation stack and make the Home screen the active screen.

Implemented in Ajax::ScreenMgr::Api.

push()

virtual void Ajax::ScreenMgr::Navigation::push ( ScreenApi &  newScreen )

pure virtualnoexcept

This method pushes the current active screen onto the navigation stack and makes the specified screen the active screen.

If the navigation stack is full, then Screen Manager 'logs an error' and the Home screen is made the active screen.

If 'newScreen' is the current home screen - this is consider an error! However, when/if this happens, the call has the same behavior as popToHome(). That said the application should NEVER rely on this behavior as it is subject to CHANGE without notice.

Implemented in Ajax::ScreenMgr::Api.

---

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

• Ajax/ScreenMgr/Navigation.h