Software Keyboard Module Function List

Software Keyboard Overview (kbd)

Initialization

KBD_Init Performs a general initialization of the software keyboard.
KBDSoundCallback Format of the callback function called for an event involving SE sound generation such as when a button on the keyboard is pressed.

Drawing

KBD_FillScreen Obtains the keyboard screen data.
KBD_LoadPltt Loads the keyboard drawing palette to the offset location calculated from the palette in the sub-2D engine's BG palette RAM.
KBD_GetCharImg Returns the pointer to the beginning of the currently displayed keyboard character image.
KBD_GetCharSize Returns the size of the keyboard character image.
KBD_Redraw Redraws the keyboard character image.

Status Updates

KBD_Update Performs a check for and an update of keyboard events.
KBD_UpdateValue Refers to the pad data and touch panel data received as an argument, and then checks and updates keyboard events.

Status Retrieval

KBD_GetInput Returns the character code (UTF-16) for characters entered using the keyboard.
KBD_GetDragging Returns the character code for a character on the keyboard if the character is being dragged.
Returns a 0 when nothing is being dragged.
KBD_IsUsing Returns TRUE if any keyboard buttons or additional event buttons are being touched. If the buttons are untouched, it returns FALSE.

Keyboard Types

KBD_ChangeByNumber Switches the keyboard by specifying the keyboard number, initializes the keyboard input, and redraws the keyboard.
KBD_ChangeToNext Switches the keyboard to the next in order, initializes the keyboard input, and redraws the keyboard.
KBD_GetKind Returns the currently displayed keyboard's type.

Cursor Processing

KBD_GetCursorPos Obtains the current coordinates of the cursor moving on the keyboard when using the +Control Pad.
KBD_InputWithCursor Records that cursor-based input from a keyboard button has occurred.

Voiced Consonants, Semivoiced Consonants, and Small Characters

KBD_ConvertDakuten Converts a character code passed as an argument to a character code of a character with a voiced consonant symbol and then returns it.
KBD_ConvertHandaku Converts a character code passed as an argument to a character code of a character with a semivoiced consonant symbol and then returns it.
KBD_ConvertSmall Converts a character code passed as an argument to a character code of a small character and then returns it.
KBD_IsDakuten Returns TRUE if a character code passed as an argument is that of a character with a voiced consonant symbol, otherwise it returns FALSE.
KBD_IsHandaku Returns TRUE if a character code passed as an argument is that of a character with a semivoiced consonant symbol, otherwise it returns FALSE.
KBD_IsSmall Returns TRUE if a character code passed as an argument is of a small character; otherwise it returns FALSE.

Drag & Drop

KBD_SetDragDropCallback Sets the callback function called when a character on the keyboard is dropped after dragging it.
KBDDragDropCallback Drag & Drop callback function type.

Additional Touch Events

KBD_SetExtTpEvent Sets the events that react to touch input, including input other than keyboard buttons. The callback function set with this function is called inside KBD_Update() (or KBD_UpdateValue()).
KBDExtTpEventCallback Additional touch event callback function type.

Input (kbd_input)

Pad

KBD_IsSetPadTrig Returns whether there is a trigger input for the specified key or button.
KBD_IsSetPadPress Returns whether there is an input for the specified key or button.
KBD_IsSetPadRelease Returns a value indicating whether the specified key or button has just been released.

Touch Panel

KBD_IsTouchedTp Returns TRUE if the touch panel is touched, otherwise returns FALSE. Also returns FALSE if the touch panel is touched but the valid data cannot be obtained.
KBD_GetTpX Returns the x-coordinate of the location touched on the touch panel. If the panel is not being touched, returns the x-coordinate for the location that was last touched.
KBD_GetTpY Returns the y-coordinate of the location touched on the touch panel. If the panel is not being touched, returns the y-coordinate for the location that was last touched.
KBD_EnableTpSampling Enables sampling of touch panel input.
KBD_DisableTpSampling Disables sampling of touch panel input.
KBD_IsEnableTpSampling Returns TRUE when sampling of touch panel input is enabled, FALSE when disabled.

Pad Repeat (kbd_autoRepeat)

Initialization

KBD_InitPadRepeat Initializes the pad repeat settings.
This function uses the default values for the number of frames prior to repeat start and for the repeat interval.
KBD_InitPadRepeatValue Initializes the pad repeat settings.
This function set the values for the number of frames prior to repeat start and for the repeat interval.

Status Retrieval

KBD_GetPadTrigRepeat Returns the trigger input and repeat trigger input values for keys or buttons.
KBD_GetPadRepeatMask Returns the logical sum of the key and button values for which repeat status is being recorded.
KBD_GetPadRepeatFrame Obtains the current frame count settings for pad repeat.