Kanzi  3.9.7
Kanzi Engine API
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:
[legend]

Public Member Functions

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

Static Public Member Functions

static FocusChainNode get (const Node &node)
 Returns the focus chain node for a node. More...
 

Public Attributes

FocusScopefocusScope
 The focus scope to whose focus chain this node belongs. More...
 
Nodenode
 The node of the focus scope. More...
 
- Public Attributes inherited from kanzi::FocusChainIndex
size_t focusOffset
 The offset to the node with the same focus order. More...
 
size_t focusOrder
 The focus chain order of the node. More...
 

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

kanzi::FocusChainNode::FocusChainNode ( )
explicitdefault

Constructor.

kanzi::FocusChainNode::FocusChainNode ( Node node)
explicit

Constructor.

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

Constructor.

Member Function Documentation

kanzi::FocusChainNode::operator bool ( ) const
inlineexplicit

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

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

Equality operator.

bool kanzi::FocusChainNode::isFocused ( ) const

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

void kanzi::FocusChainNode::reset ( )

Resets the focus chain node fields to an invalid state.

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

Returns the focus chain node for a node.

Parameters
nodeThe node for which to return the focus chain node.

Member Data Documentation

Node* kanzi::FocusChainNode::node

The node of the focus scope.

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: