kanzi::PageNavigationTracker Class Reference

Page navigation tracker manages navigation requests in scene tree. More...

#include <kanzi/node/page_navigation_tracker.hpp>

Public Member Functions
	PageNavigationTracker ()
	Constructor. More...
bool	navigateTo (Page *page, bool immediate)
	Requests navigation to given page. More...
void	attach (Page *page)
	Attaches this navigation tracker to given page. More...
void	detach (Page *page)
	Detaches this navigation tracker from given page. More...
bool	isTransitionInProgress () const
	Checks whether there's navigation ongoing. More...

Detailed Description

Page navigation tracker manages navigation requests in scene tree.

See also

#Page.

Constructor & Destructor Documentation

kanzi::PageNavigationTracker::PageNavigationTracker ( )

explicit

Constructor.

Member Function Documentation

bool kanzi::PageNavigationTracker::navigateTo	(	Page *	page,
		bool	immediate
	)

Requests navigation to given page.

Parameters

page	The page being navigated in to.
immediate	If true, plays transitions. Otherwise skips them and navigation is completed after the call returns.

Returns

True if navigation is allowed. Navigation may fail if there's navigation already ongoing.

void kanzi::PageNavigationTracker::attach

(

Page *

page

)

Attaches this navigation tracker to given page.

Navigation tracker starts to manage navigation requests for the sub-tree.

Parameters

page	The page being attached in to.

void kanzi::PageNavigationTracker::detach

(

Page *

page

)

Detaches this navigation tracker from given page.

Navigation tracker will no-longer operate.

Parameters

page	The page being detached from.

bool kanzi::PageNavigationTracker::isTransitionInProgress

(

)

const

Checks whether there's navigation ongoing.

Returns

true, if there's navigation in progress, otherwise false.

---

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

• node/page_navigation_tracker.hpp