wut  v1.7.0
Wii U Toolchain
Data Structures | Namespaces | Enumerations | Functions
swkbd_cpp.h File Reference
#include <wut.h>
#include <coreinit/filesystem.h>
#include <nn/result.h>
#include <padscore/kpad.h>
#include <vpad/input.h>
#include <string.h>
Include dependency graph for swkbd_cpp.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ConfigArg
 Configuration options for the virtual keyboard. More...
 
struct  ReceiverArg
 
struct  KeyboardArg
 Arguments for the swkbd keyboard. More...
 
struct  InputFormArg
 Arguments for swkbd the input form (text area). More...
 
struct  AppearArg
 Arguments for the swkbd input form and keyboard. More...
 
struct  CreateArg
 The arguments used to initialise swkbd and pass in its required resources. More...
 
struct  ControllerInfo
 Input and controller information for swkbd. More...
 
struct  DrawStringInfo
 
struct  KeyboardCondition
 

Namespaces

 nn
 
 nn::swkbd
 Graphical software keyboard, supporting several languages and configurations.
 

Enumerations

enum class  ControllerType {
  WiiRemote0 = 0 ,
  WiiRemote1 = 1 ,
  WiiRemote2 = 2 ,
  WiiRemote3 = 3 ,
  DrcGamepad = 4
}
 
enum class  LanguageType {
  Japanese = 0 ,
  English = 1 ,
  French = 2 ,
  German = 3 ,
  Italian = 4 ,
  Spanish = 5 ,
  SimplifiedChinese = 6 ,
  Korean = 7 ,
  Dutch = 8 ,
  Portuguese = 9 ,
  Russian = 10 ,
  TraditionalChinese = 11 ,
  Invalid = 12
}
 If the LanguageType and RegionType are not compatible, the LanguageType will be set to English, unless the RegionType is set to "Japan," in which case the LanguageType will be set to Japanese. More...
 
enum class  RegionType {
  Japan = 0 ,
  USA = 1 ,
  Europe = 2 ,
  China = 3 ,
  Korea = 4 ,
  Taiwan = 5
}
 
enum class  State {
  Hidden = 0 ,
  FadeIn = 1 ,
  Visible = 2 ,
  FadeOut = 3
}
 
enum class  InputFormType {
  InputForm0 = 0 ,
  Default = 1
}
 
enum class  KeyboardMode {
  Full = 0 ,
  Numpad = 1 ,
  Utf8 = 2 ,
  NNID = 3
}
 
enum class  PasswordMode {
  Clear = 0 ,
  Hide = 1 ,
  Fade = 2
}
 

Functions

bool AppearInputForm (const AppearArg &args)
 Show an input form (keyboard with text area) with the given configuration. More...
 
bool AppearKeyboard (const KeyboardArg &args)
 Show a keyboard with the given configuration. More...
 
void CalcSubThreadFont ()
 Calculate font data. More...
 
void CalcSubThreadPredict ()
 Calculate word prediction data. More...
 
void Calc (const ControllerInfo &controllerInfo)
 Respond to user inputs and calculate the state of input buffers and graphics. More...
 
void ConfirmUnfixAll ()
 
bool Create (const CreateArg &args)
 Initialise the swkbd library and create the keyboard and input form. More...
 
void Destroy ()
 Clean up and shut down the swkbd library. More...
 
bool DisappearInputForm ()
 Hide a previously shown input form. More...
 
bool DisappearKeyboard ()
 Hide a previously shown keyboard. More...
 
void DrawDRC ()
 Draw the keyboard to the DRC. More...
 
void DrawTV ()
 Draw the keyboard to the TV. More...
 
void GetDrawStringInfo (DrawStringInfo *drawStringInfo)
 
const char16_t * GetInputFormString ()
 Get the string the user typed into the input form. More...
 
void GetKeyboardCondition (KeyboardCondition *keyboardCondition)
 
State GetStateInputForm ()
 Get the current state of the input form. More...
 
State GetStateKeyboard ()
 
uint32_t GetWorkMemorySize (uint32_t unk)
 Get the required size for swkbd's work memory buffer. More...
 
void InactivateSelectCursor ()
 
bool InitLearnDic (void *dictionary)
 
bool IsCoveredWithSubWindow ()
 
bool IsDecideCancelButton (bool *outIsSelected)
 Gets the current status of the Cancel button on the keyboard. More...
 
bool IsDecideOkButton (bool *outIsSelected)
 Gets the current status of the OK button on the keyboard. More...
 
bool IsKeyboardTarget (IEventReceiver *eventReceiver)
 
bool IsNeedCalcSubThreadFont ()
 Determines whether the font data needs calculating. More...
 
bool IsNeedCalcSubThreadPredict ()
 Determines whether the prediction data needs calculating. More...
 
bool IsSelectCursorActive ()
 Determines whether the selection cursor is active. More...
 
void MuteAllSound (bool muted)
 Mutes or unmutes the sounds generated by the keyboard. More...
 
void SetControllerRemo (ControllerType type)
 
void SetCursorPos (int pos)
 Set the character at which the cursor is positioned. More...
 
void SetEnableOkButton (bool enable)
 Enables and disables the OK button on the keyboard. More...
 
void SetInputFormString (const char16_t *str)
 Sets the text in the input form. More...
 
void SetReceiver (const ReceiverArg &receiver)
 
void SetSelectFrom (int)
 
void SetUserControllerEventObj (IControllerEventObj *controllerEventObj)
 
void SetUserSoundObj (ISoundObj *soundObj)
 

Data Structure Documentation

◆ nn::swkbd::ReceiverArg

struct nn::swkbd::ReceiverArg

Definition at line 194 of file swkbd_cpp.h.

Data Fields
uint32_t unk_0x00
uint32_t unk_0x04
uint32_t unk_0x08
int32_t unk_0x0C
uint32_t unk_0x10
int32_t unk_0x14

◆ nn::swkbd::KeyboardArg

struct nn::swkbd::KeyboardArg

Arguments for the swkbd keyboard.

Definition at line 212 of file swkbd_cpp.h.

Data Fields
ConfigArg configArg Configuration for the keyboard itself.
ReceiverArg receiverArg

◆ nn::swkbd::InputFormArg

struct nn::swkbd::InputFormArg

Arguments for swkbd the input form (text area).

Definition at line 221 of file swkbd_cpp.h.

Data Fields
InputFormType type The type of input form.
int32_t unk_0x04
const char16_t * initialText Initial string to open the keyboard with.
const char16_t * hintText Hint string.
int32_t maxTextLength The maximum number of characters that can be entered, -1 for unlimited.
PasswordMode passwordMode Which password inputting preset to use.
uint32_t unk_0x18
bool drawInput0Cursor Whether or not to draw a cursor. Exclusive to the inputform0 input form type.
bool higlightInitialText Whether or not to highlight the initial string. Exclusive to the Default input form type.
bool showCopyPasteButtons Whether or not to show a copy and a paste button.

◆ nn::swkbd::AppearArg

struct nn::swkbd::AppearArg

Arguments for the swkbd input form and keyboard.

Definition at line 256 of file swkbd_cpp.h.

Data Fields
KeyboardArg keyboardArg Arguments for the virtual keyboard.
InputFormArg inputFormArg Arguments for the input form (text area)

◆ nn::swkbd::CreateArg

struct nn::swkbd::CreateArg

The arguments used to initialise swkbd and pass in its required resources.

Definition at line 266 of file swkbd_cpp.h.

Data Fields
void * workMemory A pointer to a work memory buffer; see GetWorkMemorySize.
RegionType regionType The swkbd region to use.
uint32_t unk_0x08
FSClient * fsClient An FSClient for swkbd to use while loading resources.

◆ nn::swkbd::ControllerInfo

struct nn::swkbd::ControllerInfo

Input and controller information for swkbd.

Definition at line 283 of file swkbd_cpp.h.

Data Fields
VPADStatus * vpad DRC input information, see VPADRead.
KPADStatus * kpad[4] Wiimote and extension controller inputs, see KPADRead.

◆ nn::swkbd::KeyboardCondition

struct nn::swkbd::KeyboardCondition

Definition at line 305 of file swkbd_cpp.h.

Data Fields
uint32_t unk_0x00 Selected Language.
uint32_t unk_0x04 Selected Character menu.