nn::swkbd::CTR Namespace

Description

The CTR software keyboard applet API namespace.
(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.

If you are using predictive text input, then the set of characters that can be entered using the software keyboard applet is the same as the CTR internal fonts, excluding the Nintendo extended characters.
Specifics are shown below.

If you are not using predictive text input, see the document CTR_SWKBD_characters.xls included in this package.

Note: Because thread priorities 17 through 20 are used by software keyboard applet threads, you must pay attention to the priorities set for any threads that continue to run while the keyboard is running.

Structures

nn::swkbd::CTR::UserWord Structure holding words registered in the user dictionary.
nn::swkbd::CTR::Config Configuration structure.
nn::swkbd::CTR::Parameter Parameter structure passed to the software keyboard applet when the applet is executed.

Enumerated Types

KeyboardType Enumerated type indicating the type of keyboard.
BottomButtonType Enumerated type for the type of the buttons on the bottom row.
BottomButton Enumerated type for the index of buttons on the bottom row.
TenkeyExtKey Enumerated type indicating the index of the numeric keypad extended keys.
FinishableCondition Enumerated type indicating the conditions to be met in order to finalize the input.
MaskMode The masking mode for input characters.
ParentalControlsMode Temporarily-disabled modes of Parental Controls.
UpperScreenFlag Flag indicating the display method for the upper screen.
TextCheckFlag Flags indicating the types of text checks.
ExtOutputDataFlag Flag indicating the type of the extended output data.
AppTextCheckResult Result of the application's text check.
ReturnCode Return codes.

typedef Definitions

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

Constants

VERSION_NUMBER The version number.
STATUS_DATA_SIZE Size of the operating status data.
LEARNING_DATA_SIZE Size of the predictive text learning data.
TEXT_LENGTH_MAX_MIN The minimum value for the maximum number of characters that can be input.
TEXT_LENGTH_MAX_MAX The maximum value for the maximum number of characters that can be input.
FIXED_WIDTH_TEXT_LENGTH_MAX_MAX The maximum value of the maximum number of characters that can be input when the display mode is fixed-width.
TEXT_CHECK_TEXT_LENGTH_MAX_MAX 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 The maximum value of the maximum number of characters that can be entered when profanity input is prohibited.
BOTTOM_BUTTON_TEXT_LENGTH_MAX The maximum number of text characters for the bottom row of buttons.
GUIDE_TEXT_LENGTH_MAX The maximum number of guide text characters.
APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX The maximum number of text characters in the application's text check dialog.
NUM_USER_WORDS_MAX The maximum number of words that can be registered in the user dictionary per each single language.
USER_WORD_LENGTH_MAX The maximum number of characters in words that can be registered to the user dictionary.
USER_READING_LENGTH_MAX 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 from the settings of 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/03/01
Initial version.

CONFIDENTIAL