TextInputFlag

Since: BlackBerry 10.0.0

#include <bb/cascades/TextInputFlag>

Flags for turning on and off different text features (for example, spell check).


Overview

Public Types Index

enum Type

Default 0x00, SpellCheck (1<<0), SpellCheckOff (1<<1), Prediction (1<<2), PredictionOff (1<<3), AutoCorrection (1<<4), AutoCorrectionOff (1<<5), AutoCapitalization (1<<6), AutoCapitalizationOff (1<<7), AutoPeriod (1<<8), AutoPeriodOff (1<<9), WordSubstitution (1<<10), WordSubstitutionOff (1<<11), VirtualKeyboard (1<<12), VirtualKeyboardOff (1<<13), LatinOnly (1<<14), LatinOnlyOff (1<<15), KeyboardUsageHints (1<<16), KeyboardUsageHintsOff (1<<17)

Public Types

Type

Text feature flags used to turn on and turn off text features.

If both the on and off flag for a certain feature is set to 1 at the same time, the behavior is undefined. If both flags are set to 0, the default behavior for the given control and input mode are used.

Since:

BlackBerry 10.0.0

Default 0x00

Default settings for all features will be used.

SpellCheck (1<<0)

Turns on spell checking.

Since:

BlackBerry 10.0.0

SpellCheckOff (1<<1)

Turns off spell checking.

Since:

BlackBerry 10.0.0

Prediction (1<<2)

Turns on word predictions.

Since:

BlackBerry 10.0.0

PredictionOff (1<<3)

Turns off word predictions.

Since:

BlackBerry 10.0.0

AutoCorrection (1<<4)

Turns on auto correction.

Since:

BlackBerry 10.0.0

AutoCorrectionOff (1<<5)

Turns off auto correction.

Since:

BlackBerry 10.0.0

AutoCapitalization (1<<6)

Turns on auto capitalization.

Since:

BlackBerry 10.0.0

AutoCapitalizationOff (1<<7)

Turns off auto capitaliztion.

Since:

BlackBerry 10.0.0

AutoPeriod (1<<8)

Turns on auto period.

Since:

BlackBerry 10.0.0

AutoPeriodOff (1<<9)

Turns off auto period.

Since:

BlackBerry 10.0.0

WordSubstitution (1<<10)

Turns on word substitution.

Since:

BlackBerry 10.0.0

WordSubstitutionOff (1<<11)

Turns off word substitution.

Since:

BlackBerry 10.0.0

VirtualKeyboard (1<<12)

Turns on virtual keyboard.

Since:

BlackBerry 10.0.0

VirtualKeyboardOff (1<<13)

Turns off virtual keyboard.

Since:

BlackBerry 10.0.0

LatinOnly (1<<14)

Forces the keyboard to Latin-1.

This affects the VKB layout and language predictions but does not filter non keyboard input such as paste or setting the text programmatically.

Since:

BlackBerry 10.2.0

LatinOnlyOff (1<<15)

Turns off force Latin-1 keyboard.

Since:

BlackBerry 10.2.0

KeyboardUsageHints (1<<16)

Turns on keyboard usage hints to help users learn how to use the features of the keyboard.

Since:

BlackBerry 10.3.0

KeyboardUsageHintsOff (1<<17)

Suppresses keyboard usage hints.

This suppresses instructions to the end user on how to use the keyboard. For example, instructions on how to accept word predictions won't show up when this flag is set. Note that these kind of instructions will automatically be suppressed as the user gains experience with using the keyboard, so you rarely need to use this flag.

Since:

BlackBerry 10.3.0

Last modified: 2014-09-30



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

comments powered by Disqus