focus_scope.hpp File Reference

#include <kanzi/core.ui/input/focus_manager.hpp>
#include <kanzi/core.ui/input/focus_navigation_manipulator.hpp>
#include <kanzi/core.ui/node/node.hpp>
#include <kanzi/core/cpp/flat_set.hpp>
#include <kanzi/core/cpp/iterator.hpp>
#include <kanzi/core/cpp/tuple.hpp>
#include <kanzi/core/util/enum_bitmask_operators.hpp>

Classes
class	kanzi::AutoClosingModalScope
	Implements the auto-closing modal scopes. More...
class	kanzi::AutoClosingModelessScope
	Implements the auto-closing modeless focus scope. More...
class	kanzi::FocusScope::FocusChain
	The FocusChain contains the snapshot of the focus chain of a focus scope. More...
struct	kanzi::FocusChainIndex
	Contains the focus order and focus order offset information of a node in a focus scope. More...
struct	kanzi::FocusChainNode
	The focus chain node of a focus scope consists of the node of the focus scope, its focus order, and the focus order offset. More...
class	kanzi::FocusFence
	Implements the focus fences. More...
class	kanzi::FocusGroup
	Implements the focus groups. More...
class	kanzi::FocusScope
	The FocusScope class holds the attributes of a focus scope: More...
class	kanzi::FocusScopeVisitor
	Focus scope visitor for UI scene traversal of focus scopes. More...
class	kanzi::ModalScope
	Implements the modal scopes. More...
class	kanzi::ModelessScope
	Implements the modeless overlay focus scopes. More...
class	kanzi::OverlayScope
	Implements the base of overlay focus scopes. More...
class	kanzi::VisitorFunction
	Wraps a focus scope visitor function into a FocusScopeVisitor. More...

Namespaces
namespace	kanzi

Macros
#define	KZ_FOCUS_LOG_CATEGORY

Typedefs
using	kanzi::PopupScope
	Implements the popup scopes.

Functions
FocusScope *	kanzi::findAncestorScopeForNode (const Node &node)
	Returns the ancestor focus scope of the node that you pass as an argument.
template<typename Predicate >
FocusScope *	kanzi::findAncestorScopeIf (Node &first, Node &last, Predicate predicate)
	Find the first ancestor scope in the [first node, last node) range, for which the predicate returns true.
template<typename Predicate >
FocusScope *	kanzi::findAncestorScopeIfNot (Node &first, Node &last, Predicate predicate)
	Find the first ancestor scope in the [first node, last node) range, for which the predicate returns false.
FocusFence *	kanzi::findFenceForNode (const Node &node)
	Returns the focus fence of the given node that you pass as an argument.
template<typename Function >
OverlayScope *	kanzi::findInputPropagationOverlayIf (OverlayScope *overlayScope, Function predicate)
	Finds the overlay focus scope that is the overlayScope, or one of its preceding overlay focus scopes to which Kanzi lets the input propagate, for which the predicate function returns true.
OverlayScope *	kanzi::findOverlayScopeForNode (const Node &node)
	Returns the overlay focus scope to which the node that you pass in this function belongs.
FocusScope *	kanzi::findScopeForNode (const Node &node)
	Returns the focus scope of the node that you pass as an argument.
template<typename Function >
void	kanzi::forEachAncestorNodeInScope (const Node &node, const FocusScope *scope, Function function)
	Execute a function for every ancestor node of the node, until and including the focus scope node that is an ancestor of the node.
template<typename Function >
void	kanzi::forEachAncestorScope (Node &first, Node &last, Function function)
	Execute a function for every focus scope in the [first node, last node) range.
template<typename Function >
void	kanzi::forEachAncestorScopeOf (Node &node, Function function)
	Executes a function for every ancestor focus scope of the node, until and including the overlay focus scope node that owns the node.
Node *	kanzi::getScopeFocusedNode (Node &node)
	Returns the last-focused node of the scope node.
bool	kanzi::isNodeInFocusableOverlay (const Node &node)
	Returns whether the given node is in one of the overlay scopes that are on top of the foremost modal scope, or in that modal scope itself.
bool	kanzi::isOverlayFocusable (const OverlayScope &overlay)
	Returns whether the given overlay is focusable.
bool	kanzi::isOverlayScope (const FocusScope *scope)
	Returns whether the focus scope passed as argument is an overlay focus scope.
	kanzi::KZ_ENABLE_BITMASK_OPERATORS (FocusScope::ScopeFlag)
bool	kanzi::operator!= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Inequality operator overload for focus chain index.
bool	kanzi::operator< (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Less operator overload for focus chain index.
bool	kanzi::operator<= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Less or equal operator overload for focus chain index.
bool	kanzi::operator== (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Equality operator overload for focus chain index.
bool	kanzi::operator> (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Greater operator overload for focus chain index.
bool	kanzi::operator>= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
	Greater or equal operator overload for focus chain index.
void	kanzi::setScopeFocusedNode (Node &scope, Node &node)
	Sets the focus node for the given scope node.
FocusChainNode	kanzi::unwrapFocusChainNode (FocusScope::FocusChain::FocusedTuple wrapped)
	Unwraps the focus chain node representation of the focused node of a focus scope from a wrapped node.

Macro Definition Documentation

KZ_FOCUS_LOG_CATEGORY

#define KZ_FOCUS_LOG_CATEGORY