Kanzi 3.9.10
FocusState Enum Reference

Specifies the focus states of a node. More...

Inheritance diagram for FocusState:
[legend]

Public Member Functions

 FocusState (FocusState enum_)
 Constructs a copy of a FocusState object.
 
 FocusState (int value)
 Constructs a FocusState of an integer value.
 
int getValue ()
 Returns the integer value of the enumeration constant.
 
final int swigValue ()
 Returns the integer value of the enumeration constant.
 

Static Public Member Functions

static FocusState swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static FocusState toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 KeyboardFocus =(2)
 The node is the keyboard focus node of the application.
 
 KeyFocus =(2)
 The node is the key focus node of the application.
 
 LogicalFocus =(1)
 The node is the logical focus node.
 
 NoFocus =(0)
 Not focused.
 

Detailed Description

Specifies the focus states of a node.

Constructor & Destructor Documentation

◆ FocusState() [1/2]

FocusState ( int value)

Constructs a FocusState of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ FocusState() [2/2]

Constructs a copy of a FocusState object.

Parameters
enum_FocusState to be copy constructed.

Member Function Documentation

◆ getValue()

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

◆ swigToEnum()

static FocusState swigToEnum ( int swigValue)
static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters
swigValueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

◆ swigValue()

final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.

◆ toEnum()

static FocusState toEnum ( int value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

Member Data Documentation

◆ KeyboardFocus

KeyboardFocus =(2)

The node is the keyboard focus node of the application.

Kanzi delivers keyboard input to the keyboard focus node.
For a focus scope node this value means that one of the nodes in that scope is the
keyboard focus node of the application.
Deprecated In Kanzi 3.9.6. Use FocusState::KeyFocus instead.

◆ KeyFocus

KeyFocus =(2)

The node is the key focus node of the application.

Kanzi delivers key input to the key focus node.
For a focus scope node this value means that one of the nodes in that scope is the
key focus node of the application.

◆ LogicalFocus

LogicalFocus =(1)

The node is the logical focus node.

The node had the key focus before the overlay, to which the node belongs, lost the focus.
When the overlay regains the focus, the logical focus node of that overlay becomes the key focus node.
For a focus scope node this value means that one of the nodes in
that scope is the logical focus node of an overlay.

◆ NoFocus

NoFocus =(0)

Not focused.

This is the default value.
For a focus scope node this value means that none of the nodes in that scope is
the focus node of the overlay to which the scope belongs.