kanzi::FocusChainNode Struct Reference

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...

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

Inheritance diagram for kanzi::FocusChainNode:

Public Member Functions
	FocusChainNode ()=default
	Constructor.
	FocusChainNode (Node &node)
	Constructor.
	FocusChainNode (Node &node, size_t offset)
	Constructor.
bool	isFocused () const
	Returns whether this focus chain element is focused or, in case it is a scope node, contains focus.
	operator bool () const
	bool() operator to check for validity of a FocusChainNode instance.
bool	operator== (const FocusChainNode &rhs) const
	Equality operator.
void	reset ()
	Resets the focus chain node fields to an invalid state.
Public Member Functions inherited from kanzi::FocusChainIndex
	FocusChainIndex ()=default
	Constructor.
	FocusChainIndex (size_t order, size_t offset)
	Constructor.
	operator bool () const
	bool() operator to check for validity of a FocusChainIndex instance.

Static Public Member Functions
static FocusChainNode	get (const Node &node)
	Returns the focus chain node for a node.

Public Attributes
FocusScope *	focusScope
	The focus scope to whose focus chain this node belongs.
Node *	node
	The node of the focus scope.
Public Attributes inherited from kanzi::FocusChainIndex
size_t	focusOffset
	The offset to the node with the same focus order.
size_t	focusOrder
	The focus chain order of the node.

Detailed Description

The focus chain node of a focus scope consists of the node of the focus scope, its focus order, and the focus order offset.

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

FocusChainNode() [1/3]

kanzi::FocusChainNode::FocusChainNode ( )

explicitdefault

Constructor.

FocusChainNode() [2/3]

kanzi::FocusChainNode::FocusChainNode ( Node & node )

explicit

Constructor.

FocusChainNode() [3/3]

kanzi::FocusChainNode::FocusChainNode ( Node & node, size_t offset )

explicit

Constructor.

Member Function Documentation

operator bool()

kanzi::FocusChainNode::operator bool ( ) const

inlineexplicit

bool() operator to check for validity of a FocusChainNode instance.

operator==()

bool kanzi::FocusChainNode::operator== ( const FocusChainNode & rhs ) const

inline

Equality operator.

isFocused()

bool kanzi::FocusChainNode::isFocused

(

)

const

Returns whether this focus chain element is focused or, in case it is a scope node, contains focus.

reset()

void kanzi::FocusChainNode::reset

(

)

Resets the focus chain node fields to an invalid state.

get()

static FocusChainNode kanzi::FocusChainNode::get ( const Node & node )

static

Returns the focus chain node for a node.

Parameters

node	The node for which to return the focus chain node.

Member Data Documentation

node

Node* kanzi::FocusChainNode::node

The node of the focus scope.

focusScope

FocusScope* kanzi::FocusChainNode::focusScope

The focus scope to whose focus chain this node belongs.

Since

Kanzi 3.9.7

---

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

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