nn::swkbd::CTR

nn::swkbd::CTR Namespace

Description

Namespace for the CTR software keyboard applet API.
(This namespace can also be written without the ::CTR portion.)

The wchar_t-type characters (or strings) handled by the software keyboard applet are all in UTF-16LE encoding, using LF newline codes.
However, only characters in the BMP (U+0000 through U+FFFF) are available. Characters outside the BMP are unsupported.

Note: Thread priorities 17 through 20 are used by software keyboard applet threads. Take this into consideration if your application sets priorities for threads that continue to run while the keyboard applet is running.

If the version of the software keyboard applet library used by the application does not match the SDK version supported by the System Updater in use, the software keyboard applet will sometimes fail to launch. If the software keyboard applet does not launch, apply the most recent System Updater.

Structures

nn::swkbd::CTR::UserWord Structure for a word registered in the user dictionary.
nn::swkbd::CTR::Config Configuration structure.
nn::swkbd::CTR::Parameter Parameter structure to pass to the software keyboard applet when it executes.

Enumerated Types

KeyboardType Enumerated type indicating the type of keyboard.
BottomButtonType Enumerated type for the types of buttons on the bottom row.
BottomButton Enumerated type for the indices of the buttons on the bottom row.
TenkeyExtKey Enumerated type indicating the index of the numeric keypad extended keys.
FinishableCondition Enumerated type for conditions under which input can be finalized.
MaskMode Enumerated type that indicates the masking mode for input characters.
ParentalControlsMode Enumerated type that represents the modes for temporarily disabling Parental Controls.
DisplayLanguage Enumerated type indicating the display language.
UpperScreenFlag Flag indicating the display method for the upper screen.
TextCheckFlag Flags indicating the types of text checks.
ExtOutputDataFlag Flags indicating the types of extended output data.
AppTextCheckResult Enumerated type that indicates the result of text checking by the application.
ReturnCode Enumerated type representing return codes.

typedef Definitions

AppTextCheckCallback Function type representing the callback for text checking performed by the application.

Constants

VERSION_NUMBER const u16 Version number.
STATUS_DATA_SIZE const size_t Size of the the operating status data.
LEARNING_DATA_SIZE const size_t Size of the predictive text learning data.
TEXT_LENGTH_MAX_MIN const u16 The minimum value for the maximum number of characters that can be input.
TEXT_LENGTH_MAX_MAX const u16 The maximum value for the maximum number of characters that can be input.
FIXED_WIDTH_TEXT_LENGTH_MAX_MAX const u16 The maximum value for the maximum number of characters that can be input in fixed-width display mode.
TEXT_CHECK_TEXT_LENGTH_MAX_MAX const u16 The maximum value for the maximum number of characters that can be input when text is being checked.
BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX const u16 The maximum value for the maximum number of characters that can be entered when input of profanity is prohibited.
BOTTOM_BUTTON_TEXT_LENGTH_MAX const u16 The maximum number of characters for the text in the bottom row of buttons.
GUIDE_TEXT_LENGTH_MAX const u16 The maximum number of characters in guide text.
APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX const u16 The maximum number of characters in the text of the application's text checking dialog.
NUM_USER_WORDS_MAX const u16 The maximum number of words that can be registered in the user dictionary for each single language.
USER_WORD_LENGTH_MAX const u16 The maximum number of characters for a word that can be registered to the user dictionary.
USER_READING_LENGTH_MAX const u16 The maximum number of characters in the reading of a word registered to the user dictionary.

Functions

InitializeConfig Initializes the Config structure to default values.
GetSharedMemorySize Calculates the size of the necessary shared memory region based on the settings in the Config structure.
PreloadKeyboardApplet Preloads the software keyboard applet.
CancelPreloadKeyboardApplet Cancels the preloading of the software keyboard applet.
WaitForPreloadKeyboardApplet Waits for the completion of preloading of the software keyboard applet.
IsRegisteredKeyboardApplet Checks whether preload of the software keyboard applet is complete.
StartKeyboardApplet Starts up the software keyboard applet.

Revision History

2011/10/07
Moved a description of the types of characters used by the software keyboard to the Specifications for System Applications and Applets.
2011/03/01
Initial version.

CONFIDENTIAL