Kanzi 3.9.10
KeyState Enum Reference

Indicates the states of a hardware key. More...

Inheritance diagram for KeyState:
[legend]

Public Member Functions

 KeyState (int value)
 Constructs a KeyState of an integer value.
 
 KeyState (KeyState enum_)
 Constructs a copy of a KeyState object.
 
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 KeyState swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static KeyState toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 Pressed =(0)
 The key is pressed.
 
 Released =(1)
 The key is released.
 

Detailed Description

Indicates the states of a hardware key.

Constructor & Destructor Documentation

◆ KeyState() [1/2]

KeyState ( int value)

Constructs a KeyState of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ KeyState() [2/2]

KeyState ( KeyState enum_)

Constructs a copy of a KeyState object.

Parameters
enum_KeyState 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 KeyState 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 KeyState 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.