kanzi::FocusManager::ScopeStack Struct Reference

Stack of the registered popup-type focus scopes. More...

#include <kanzi/core.ui/input/focus_manager.hpp>

Public Member Functions
void	bringToFront (ModalScope &scope)
	Sets a modal focus scope as the foremost scope, which then becomes the active modal focus scope. More...
ModalScope *	getFront () const
	Returns the foremost focus scope. More...
ModalScope *	getPrecedingScope (const ModalScope &scope) const
	Returns the modal focus scope that precedes the modal focus scope that you pass as an argument. More...
ModalScope *	getSecondFront () const
	Returns the second foremost focus scope. More...
void	remove (ModalScope &scope)
	Removes a modal focus scope from the collection. More...
void	replace (ModalScope &original, ModalScope &newScope)
	Replaces a modal focus scope with another modal focus scope. More...
void	sendToBack (ModalScope &scope)
	Moves a modal focus scope to the end of the scope collection. More...

Detailed Description

Stack of the registered popup-type focus scopes.

Since

Kanzi 3.9.0

Member Function Documentation

getFront()

ModalScope* kanzi::FocusManager::ScopeStack::getFront

(

)

const

Returns the foremost focus scope.

Returns

The foremost focus scope. If there is no popup or modal focus scope registered, returns nullptr.

getSecondFront()

ModalScope* kanzi::FocusManager::ScopeStack::getSecondFront

(

)

const

Returns the second foremost focus scope.

Returns

The second foremost focus scope. If there is only one focus scope in the collection, returns nullptr.

getPrecedingScope()

ModalScope* kanzi::FocusManager::ScopeStack::getPrecedingScope

(

const ModalScope &

scope

)

const

Returns the modal focus scope that precedes the modal focus scope that you pass as an argument.

Parameters

scope

The focus scope for which you want to get the preceding modal focus scope.

Returns

The preceding modal focus scope. If the modal focus scope is the only focus scope in the stack, or the focus scope is the first modal focus scope in the stack, nullptr.

remove()

void kanzi::FocusManager::ScopeStack::remove

(

ModalScope &

scope

)

Removes a modal focus scope from the collection.

Parameters

scope

The modal focus scope to remove.

bringToFront()

void kanzi::FocusManager::ScopeStack::bringToFront

(

ModalScope &

scope

)

Sets a modal focus scope as the foremost scope, which then becomes the active modal focus scope.

The previous foremost modal focus scope becomes the second foremost scope.

Parameters

scope

The modal focus scope that you want to set as the foremost scope.

sendToBack()

void kanzi::FocusManager::ScopeStack::sendToBack

(

ModalScope &

scope

)

Moves a modal focus scope to the end of the scope collection.

The second foremost modal focus scope becomes the foremost scope, which then becomes the active modal focus scope. If the modal focus scope is not registered, it adds the scope to the collection as the last registered modal focus scope.

Parameters

scope

The modal focus scope that you want to send to the end of the scope collection.

replace()

void kanzi::FocusManager::ScopeStack::replace	(	ModalScope &	original,
		ModalScope &	newScope
	)

Replaces a modal focus scope with another modal focus scope.

Kanzi calls this method when the FocusManager::FocusScopeTypeProperty value changes on a Node.

Parameters

original	The modal focus scope that you want to replace.
newScope	The modal focus scope with which you want to replace the original modal focus scope.

---

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

• kanzi/core.ui/input/focus_manager.hpp