Class Key

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

The key structure is used to store a key press.

C#
Copy
public class Key : BaseHandle, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable
Inheritance
Implements

Constructors

View Source

Key()

The default constructor.

Declaration
C#
Copy
public Key()
API Level: 3

Properties

View Source

DeviceClass

Get the device class the key event originated from.

Declaration
C#
Copy
public DeviceClassType DeviceClass { get; }
Property Value
Type Description
DeviceClassType
API Level: 3
View Source

DeviceName

Device name

Declaration
C#
Copy
public string DeviceName { get; }
Property Value
Type Description
String
API Level: 3
View Source

DeviceSubClass

Get the device subclass the key event originated from.

Declaration
C#
Copy
public DeviceSubClassType DeviceSubClass { get; }
Property Value
Type Description
DeviceSubClassType
API Level: 4
View Source

KeyCode

Keycode for the key pressed.

Declaration
C#
Copy
public int KeyCode { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

KeyModifier

Special keys like Shift, Alt, and Ctrl which modify the next key pressed.

Declaration
C#
Copy
public int KeyModifier { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

KeyPressed

Get the actual string returned that should be used for input editors.

Declaration
C#
Copy
public string KeyPressed { get; }
Property Value
Type Description
String

The key string

View Source

KeyPressedName

Name given to the key pressed.

Declaration
C#
Copy
public string KeyPressedName { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

KeyString

Get the actual string returned that should be used for input editors.

Declaration
C#
Copy
public string KeyString { get; set; }
Property Value
Type Description
String

The key string

View Source

LogicalKey

Get the logical key string. (eg. shift + 1 == "exclamation")

Declaration
C#
Copy
public string LogicalKey { get; }
Property Value
Type Description
String

The logical key symbol

View Source

State

State of the key event.

Declaration
C#
Copy
public Key.StateType State { get; set; }
Property Value
Type Description
Key.StateType
API Level: 3
View Source

Time

The time (in ms) that the key event occurred.

Declaration
C#
Copy
public uint Time { get; set; }
Property Value
Type Description
UInt32
API Level: 3

Methods

View Source

IsAltModifier()

Checks to see if Alt key modifier has been supplied.

Declaration
C#
Copy
public bool IsAltModifier()
Returns
Type Description
Boolean

True if Alt modifier.

API Level: 3
View Source

IsCtrlModifier()

Checks to see if Ctrl (control) key modifier has been supplied.

Declaration
C#
Copy
public bool IsCtrlModifier()
Returns
Type Description
Boolean

True if Ctrl modifier.

API Level: 3
View Source

IsShiftModifier()

Checks to see if the Shift key modifier has been supplied.

Declaration
C#
Copy
public bool IsShiftModifier()
Returns
Type Description
Boolean

True if Shift modifier.

API Level: 3
View Source

ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)

Declaration
C#
Copy
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type Name Description
Tizen.System.Runtime.InteropServices.HandleRef swigCPtr
Overrides

Implements

Extension Methods