KeyLayout

Since: BlackBerry 10.3.0

#include <bb/cascades/KeyLayout>

This class defines an enumerator that lists all possible keyboard layouts.

The keyboard layout affects the layout of keys on the virtual keyboard and the interpretation of key presses on a physical keyboard, depending on the device being used. For example, the PhoneNumber enumerated value displays a number-pad on a virtual keyboard, and also removes the need to use the modifier key to enter numbers on a device with a physical keyboard.

The keyboard layout depends on TextInputProperties::keyLayout property and TextArea::inputMode or TextField::inputMode. If TextInputProperties::keyLayout and inputMode define different modes, TextInputProperties::keyLayout will take priority for the keyboard layout.


Overview

Public Types Index

enum Type

Default = 0, Text = 1, Url = 2, EmailAddress = 3, NumbersAndPunctuation = 4, PhoneNumber = 5, Pin = 6, Alphanumeric = 7, SimPin = 8, Number = 9, Contact = 10

Public Types

Type

Specifies the preferred keyboard layout.

Since:

BlackBerry 10.3.0

Default = 0

Sets the preferred keyboard layout to "Default".

Text = 1

Sets the preferred keyboard layout to text.

A keyboard layout for entering plain text.

Since:

BlackBerry 10.3.0

Url = 2

Sets the preferred keyboard layout to URL.

A keyboard layout for entering URLs.

Since:

BlackBerry 10.3.0

EmailAddress = 3

Sets the preferred keyboard layout to email.

A keyboard layout for entering email addresses.

Since:

BlackBerry 10.3.0

NumbersAndPunctuation = 4

Sets the preferred keyboard layout to numbers and punctuation.

A keyboard layout for entering numbers and punctuation.

Since:

BlackBerry 10.3.0

PhoneNumber = 5

Sets the preferred keyboard layout to phone.

A keyboard layout for entering phone numbers.

Since:

BlackBerry 10.3.0

Pin = 6

Sets the preferred keyboard layout to pin.

A keyboard layout for entering PINs.

Since:

BlackBerry 10.3.0

Alphanumeric = 7

Sets the preferred keyboard layout to alpha numeric.

A keyboard layout for entering numbers and letters.

Since:

BlackBerry 10.3.0

SimPin = 8

Sets the preferred keyboard layout to SIM pin.

A keyboard layout for entering the PIN of a SIM card.

Since:

BlackBerry 10.3.0

Number = 9

Sets the preferred keyboard layout to number.

A keyboard layout for entering numbers.

Since:

BlackBerry 10.3.0

Contact = 10

Sets the preferred keyboard layout to contact.

A keyboard layout for entering contact information. Use Contact instead of EmailAddress when you need the space character easily available on any type of device keyboard.

Since:

BlackBerry 10.3.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus