1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::swkbd::CTR::Config</title> 49 </head> 50 <body> 51<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/swkbd/Overview.html">swkbd</a>::<a href="../../../../nn/swkbd/CTR/Overview.html">CTR</a>::Config</CODE> Structure</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54<pre class="definition">struct Config 55{ 56<a href="../../../../nn/swkbd/CTR/KeyboardType.html">KeyboardType</a> keyboardType; 57<a href="../../../../nn/swkbd/CTR/BottomButtonType.html">BottomButtonType</a> bottomButtonType; 58<a href="../../../../nn/swkbd/CTR/FinishableCondition.html">FinishableCondition</a> finishableCondition; 59<a href="../../../../nn/swkbd/CTR/MaskMode.html">MaskMode</a> maskMode; 60<a href="../../../../nn/swkbd/CTR/ParentalControlsMode.html">ParentalControlsMode</a> parentalControlsMode; 61<a href="../../../../nn_types/bit32.html">bit32</a> upperScreenFlag; 62<a href="../../../../nn_types/bit32.html">bit32</a> textCheckFlag; 63<a href="../../../../nn_types/bit32.html">bit32</a> extOutputDataFlag; 64<a href="../../../../nn_types/u16.html">u16</a> textLengthMax; 65<a href="../../../../nn_types/u16.html">u16</a> numUserWords; 66<a href="../../../../nn_types/u16.html">u16</a> numNumbersMax; 67wchar_t bottomButtonText[BOTTOM_BUTTON_MAX][BOTTOM_BUTTON_TEXT_LENGTH_MAX+1]; 68wchar_t tenkeyExtKeyChar[TENKEY_EXT_KEY_MAX]; 69wchar_t guideText[GUIDE_TEXT_LENGTH_MAX+1]; 70bool prediction; 71bool lineFeed; 72bool fixedWidthMode; 73bool homeButton; 74bool softwareReset; 75bool powerButton; 76bool communicateWithOtherRegions; 77bool bootWithQwerty; 78bool bottomButtonToFinish[BOTTOM_BUTTON_MAX]; 79<a href="../../../../nn/swkbd/CTR/DisplayLanguage.html">DisplayLanguage</a> displayLanguage; 80<a href="../../../../nn_types/sptr.html">sptr</a> initialInputText; 81<a href="../../../../nn_types/sptr.html">sptr</a> userWordArray; 82<a href="../../../../nn_types/sptr.html">sptr</a> initialStatusData; 83<a href="../../../../nn_types/sptr.html">sptr</a> initialLearningData; 84size_t sharedMemorySize; 85<a href="../../../../nn_types/u16.html">u16</a> versionNumber; 86<a href="../../../../nn/swkbd/CTR/ReturnCode.html">ReturnCode</a> returnCode; 87<a href="../../../../nn_types/sptr.html">sptr</a> statusData; 88<a href="../../../../nn_types/sptr.html">sptr</a> learningData; 89<a href="../../../../nn_types/sptr.html">sptr</a> inputText; 90<a href="../../../../nn_types/u16.html">u16</a> inputTextLength; 91<a href="../../../../nn/swkbd/CTR/AppTextCheckResult.html">AppTextCheckResult</a> appTextCheckResult; 92wchar_t appTextCheckDialogText[APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX+1]; 93bool skipAtMarkCheck; 94<a href="../../../../nn_types/u8.html">u8</a> reserved[171]; 95}; 96</pre> 97 </div> 98<h2>Description</h2> 99 <div class="section"> 100<p>Configuration structure.</p><p>This structure is exchanged between the application and the software keyboard applet and stores various data.<br /><h2>Input Parameters Passed to the Applet</h2> 101In addition to parameters that specify the behavior of the software keyboard, this structure also stores information about the text entered by the user.</p><p>You must always call the <a href="../../../../nn/swkbd/CTR/InitializeConfig.html"><CODE>nn::swkbd::CTR::InitializeConfig</CODE></a> function to initialize this structure before setting its member variables.<br />However, the only member variables whose values you can set directly are the ones classified on this page as <I>Input (Direct Setting Possible)</I>. Changing the values of the other member variables might cause a malfunction.</p><h2>Details of Input Members</h2><h3><CODE>keyboardType</CODE></h3><p> 102Use the <CODE><a href="../../../../nn/swkbd/CTR/KeyboardType.html">nn::swkbd::CTR::KeyboardType</a></CODE> enumerated type to specify the type of keyboard you want to use. If you specify any value other than <CODE>KEYBOARD_TYPE_FULL</CODE>, predictive text is not available. If you specify <CODE>KEYBOARD_TYPE_TENKEY</CODE>, newlines are also disabled. 103</p><h3><CODE>bottomButtonType</CODE></h3><p> 104Use the <a href="../../../../nn/swkbd/CTR/BottomButtonType.html"><CODE>nn::swkbd::CTR::BottomButtonType</CODE></a> enumerated type to specify the type of the bottom-row buttons (the buttons laid out along the lowest edge of the screen). 105</p><h3><CODE>finishableCondition</CODE></h3><p> 106Use the <CODE><a href="../../../../nn/swkbd/CTR/FinishableCondition.html">nn::swkbd::CTR::FinishableCondition</a></CODE> enumerated type to specify the conditions that must be met for users to finalize their text input. Users cannot finalize any text input unless they meet these conditions. 107</p><h3><CODE>maskMode</CODE></h3><p> 108Use the <a href="../../../../nn/swkbd/CTR/MaskMode.html"><CODE>nn::swkbd::CTR::MaskMode</CODE></a> enumerated type to specify the method to use when masking user-entered content.<br />When you specify any value other than <CODE>MASK_MODE_DISABLE</CODE>, user-entered characters are replaced with asterisks (*) using the specified method. Newlines, however, are not replaced. 109</p><h3><CODE>parentalControlsMode</CODE></h3><p> 110Use the <a href="../../../../nn/swkbd/CTR/ParentalControlsMode.html"><CODE>nn::swkbd::CTR::ParentalControlsMode</CODE></a> enumerated type to specify whether to start the software keyboard in a special format that allows the user to temporarily disable Parental Controls.<br />When you specify any value other than <CODE>PARENTAL_CONTROLS_MODE_DISABLE</CODE>, the settings of all the other member variables except <CODE>upperScreenFlag</CODE>, <CODE>homeButton</CODE>, and <CODE>softwareReset</CODE> are ignored. 111</p><h3><CODE>upperScreenFlag</CODE></h3><p> 112Use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>nn::swkbd::CTR::UpperScreenFlag</CODE></a> enumerated type flags to specify how to display the upper screen. 113</p><h3><CODE>textCheckFlag</CODE></h3><p> 114Use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>nn::swkbd::CTR::TextCheckFlag</CODE></a> enumerated type flags to specify the types of text checks you want to perform while the software keyboard is running.<br />When you specify any value other than <CODE>TEXT_CHECK_DISABLE</CODE>, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/TEXT_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::TEXT_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a>. If you specify <CODE>TEXT_CHECK_BANNED_WORDS</CODE>, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a> and newlines are disabled. 115</p><h3><CODE>extOutputDataFlag</CODE></h3><p> 116Use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>nn::swkbd::CTR::ExtOutputDataFlag</CODE></a> enumerated type flags to specify the types of any data you want to output in addition to the user-entered text and the return code. 117</p><h3><CODE>numUserWords</CODE></h3><p>Specify the number of elements in the <a href="../../../../nn/swkbd/CTR/UserWord/Overview.html"><CODE>nn::swkbd::CTR::UserWord</CODE></a> structure array to pass as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function.<br />If using user dictionaries, always set an appropriate value here. 118</p><h3><CODE>numNumbersMax</CODE></h3><p> 119Specify the maximum number of numbers that users can input when <CODE>TEXT_CHECK_NUMBER</CODE> is set in the <CODE>textCheckFlag</CODE> member variable and you want to restrict numerical input.<br />Specify <CODE>0</CODE> to completely prohibit the input of numbers.<br />When <CODE>TEXT_CHECK_NUMBER</CODE> is not set in the <CODE>textCheckFlag</CODE> member variable, this member variable's setting is ignored. 120</p><h3><CODE>bottomButtonText</CODE></h3><p> 121Specify a null-terminated string for the text to display on the bottom-row buttons.<br />Use the <a href="../../../../nn/swkbd/CTR/BottomButton.html"><CODE>nn::swkbd::CTR::BottomButton</CODE></a> enumerated type to specify the primary index of the array. If you specify an empty string, the default text for the system's region and language settings will be used. 122</p><h3><CODE>tenkeyExtKeyChar</CODE></h3><p> 123 124Specify the characters to assign to the keys placed to the immediate left and right of the <CODE>0</CODE> key on the numeric keypad.<br />Use the <a href="../../../../nn/swkbd/CTR/TenkeyExtKey.html"><CODE>nn::swkbd::CTR::TenkeyExtKey</CODE></a> enumerated type to specify the index of the array.<br />Basically, the characters you specify are displayed unchanged on the keys, but there is an exception: if you specify a single-byte space (<CODE>0x0020</CODE>) a special extended character is displayed on the key.<br />You cannot specify any of the control characters from <CODE>0x0001</CODE> to <CODE>0x001F</CODE>. If you specify a null character, that key is not displayed. 125</p><h3><CODE>guideText</CODE></h3><p> 126 127Specify a null-terminated string to serve as <I>guide text</I> (the text displayed in an input field before the user enters any characters in that field).<br />Note that guide text is not displayed when <CODE>true</CODE> is specified for the <CODE>fixedWih3hMode</CODE> member variable, causing the keyboard to start in fixed-width display mode. 128</p><h3><CODE>fixedWih3hMode</CODE></h3><p> 129Specify whether to start the software keyboard in fixed-width display mode.<br />If you specify <CODE>true</CODE>, the keyboard starts in fixed-width display mode. Entered text is displayed as fixed-width and the number of characters that can be input is visible. In addition, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/FIXED_WIDTH_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::FIXED_WIDTH_TEXT_LENGTH_MAX_MAX</CODE></a> and newlines are disabled. 130</p><h3><CODE>homeButton</CODE></h3><p> 131 132Specify whether to end the software keyboard when HOME is pressed.<br />When you specify <CODE>true</CODE>, the software keyboard ends and outputs any existing user-entered text when HOME is pressed. <br /><B>Note:</B> When the keyboard ends this way, the output text does not undergo any of the text checks specified by the <CODE>textCheckFlag</CODE> member variable. Be careful about using such unchecked text. 133</p><h3><CODE>softwareReset</CODE></h3><p> 134 135Specify whether to enable software resets.<br />When you specify <CODE>true</CODE>, the software keyboard ends when the button combination for a software reset is pressed. 136<h3><CODE>powerButton</CODE></h3><p> 137 138Specify whether to end the software keyboard when the POWER button is pressed.<br />In general, do not change this from the default value of <CODE>true</CODE>. 139</p><h3><CODE>communicateWithOtherRegions</CODE></h3> 140Specify whether the application exchanges data with other regions.<br />When <CODE>TEXT_CHECK_BANNED_WORDS</CODE> is set in the <CODE>textCheckFlag</CODE> member variable, the text patterns that are checked for are changed as a result of this member variable's setting.<br />When <CODE>TEXT_CHECK_BANNED_WORDS</CODE> is not set in the <CODE>textCheckFlag</CODE> member variable, this member variable's setting is ignored. This variable is not currently accessed.</b></p><h3><CODE>bootWithQwerty</CODE></h3><p> 141 142Specify whether to forcibly set the key layout to the QWERTY layout at startup.<br />When you specify <CODE>false</CODE>, the key layout selected at startup differs depending on the language setting.<br />Specifically, the layout is kana for Japanese, Cyrillic for Russian, and QWERTY for all other languages.<br />This member variable's setting is ignored, however, when you specify any value other than <CODE>KEYBOARD_TYPE_FULL</CODE> for the <CODE>KeyboardType</CODE> member variable, or when the initial operating status data is passed as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function. 143</p><h3><CODE>bottomButtonToFinish</CODE></h3><p> 144 145Specify which of the bottom-row buttons is the <B>OK</B> button (the button the user presses to finalize input).<br />Use the <a href="../../../../nn/swkbd/CTR/BottomButton.html"><CODE>nn::swkbd::CTR::BottomButton</CODE></a> enumerated type to specify the index in the array, and specify <CODE>true</CODE> to make that button the <B>OK</B> button.<br />The bottom-row button specified as the <B>OK</B> button is not tappable until the conditions for finalizing input (specified in the <CODE>finishableCondition</CODE> member variable) are met. 146</p><h3><CODE>displayLanguage</CODE></h3><p> 147 148Use the <CODE><a href="../../../../nn/swkbd/CTR/DisplayLanguage.html">nn::swkbd::CTR::DisplayLanguage</a></CODE> enumerated type to specify which language to use when displaying various text on the software keyboard.<br />The keyboard layout and the scope of available characters will change based on the language set here. If the default value (<CODE>DISPLAY_LANGUAGE_DEFAULT</CODE>) is specified, the language specified in the System Settings is used. If a language that cannot be specified in System Settings is specified here, Japanese will be assumed for systems whose system region is Japan, and English will be assumed for systems whose system region is the Americas or Europe. 149</p><h2>Output Parameters Received from the Applet</h2><p> 150The data output when the software keyboard ends can be obtained by checking the values of the member variables classified as <I>Output</I> in the <B>Member Variables</B> section of this page.<br />Any comparatively large data items are stored in the shared memory that was passed as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function. The starting addresses of the data items are stored in the output member variables of this structure as offsets from the start of shared memory. Obtain the data by referencing those values. 151</p><h2>Details of Output Members</h2><h3><CODE>returnCode</CODE></h3><p> 152 153Stores the return code that indicates the reason why the software keyboard ended.<br />Among these codes are codes indicating that the POWER Button or the HOME Button was pressed, but those codes alone do not allow you to determine whether to call the <a href="../../../../nn/applet/CTR/ProcessPowerButton.html"><CODE>nn::applet::CTR::ProcessPowerButton</CODE></a> or <a href="../../../../nn/applet/CTR/ProcessHomeButton.html"><CODE>nn::applet::CTR::ProcessHomeButton</CODE></a> function.<br />To determine whether it is necessary to call those functions, you must call the <a href="../../../../nn/applet/CTR/IsExpectedToProcessPowerButton.html"><CODE>nn::applet::CTR::IsExpectedToProcessPowerButton</CODE></a> and <a href="../../../../nn/applet/CTR/IsExpectedToProcessHomeButton.html"><CODE>nn::applet::CTR::IsExpectedToProcessHomeButton</CODE></a> functions. 154</p><h3><CODE>statusData</CODE></h3><p> 155 156Stores the starting address of the operating status data describing the software keyboard's status when it ended. (This address is stored as an offset from the start of the shared memory region.)<br />A value of <CODE>-1</CODE> is stored when <CODE>EXT_OUTPUT_DATA_STATUS</CODE> was not set in the <CODE>extOutputDataFlag</CODE> member variable of this structure when the software keyboard was started.<br />The size of the data is defined by <a href="../../../../nn/swkbd/CTR/STATUS_DATA_SIZE.html"><CODE>nn::swkbd::CTR::STATUS_DATA_SIZE</CODE></a>.<br />If you pass this data as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function the next time the software keyboard is started, you can carry over the keyboard's operating status from the previous time it was used. 157</p><h3><CODE>learningData</CODE></h3><p> 158 159Stores the starting address of the predictive text learning data from when the software keyboard ended. (This address is stored as an offset from the start of the shared memory region.)<br />A value of <CODE>-1</CODE> is stored when <CODE>EXT_OUTPUT_DATA_LEARNING</CODE> was not set in the <CODE>extOutputDataFlag</CODE> member variable of this structure when the software keyboard was started.<br />The size of the data is defined by <a href="../../../../nn/swkbd/CTR/LEARNING_DATA_SIZE.html"><CODE>nn::swkbd::CTR::LEARNING_DATA_SIZE</CODE></a>.<br />If you pass this data as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function the next time the software keyboard is started, you can carry over the keyboard's learning status from the previous time it was used. 160</p><h3><CODE>inputText</CODE></h3><p> 161 162Stores the starting address of the user-entered string. (This address is stored as an offset from the start of the shared memory region.)<br />Strings are of the <CODE>wchar_t</CODE> type and are null-terminated. A value of <CODE>-1</CODE> is stored if the software keyboard was closed without input being finalized. 163</p><h3><CODE>inputTextLength</CODE></h3><p> 164 165Stores the length of the user-entered string. The null terminator is not included in this length. 166 </p></div> 167 <a name="variable" id="variable"> 168<h2>Member Variables</h2> 169 <div class="section"> 170 <table class="members"> 171 <tr> 172<th class="category" colspan="4">Input (Direct Setting Possible)</th> 173 </tr> 174 <tr> 175 <td width="100"> </td> 176 <th> 177<span class="argument"><CODE>keyboardType</CODE></span> 178 </th> 179<td width="100"><a href="../../../../nn/swkbd/CTR/KeyboardType.html"><CODE>KeyboardType</CODE></a></td> 180<td>The keyboard type.</td> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185<span class="argument"><CODE>bottomButtonType</CODE></span> 186 </th> 187<td width="100"><a href="../../../../nn/swkbd/CTR/BottomButtonType.html"><CODE>BottomButtonType</CODE></a></td> 188<td>The type of the bottom-row buttons.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193<span class="argument"><CODE>finishableCondition</CODE></span> 194 </th> 195<td width="100"><a href="../../../../nn/swkbd/CTR/FinishableCondition.html"><CODE>FinishableCondition</CODE></a></td> 196<td>Conditions under which input can be finalized.</td> 197 </tr> 198 <tr> 199 <td width="100"> </td> 200 <th> 201<span class="argument"><CODE>maskMode</CODE></span> 202 </th> 203<td width="100"><a href="../../../../nn/swkbd/CTR/MaskMode.html"><CODE>MaskMode</CODE></a></td> 204<td>The masking mode for input characters.</td> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209<span class="argument"><CODE>parentalControlsMode</CODE></span> 210 </th> 211<td width="100"><a href="../../../../nn/swkbd/CTR/ParentalControlsMode.html"><CODE>ParentalControlsMode</CODE></a></td> 212<td>Allows or prevents temporary disabling of Parental Controls.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<span class="argument"><CODE>upperScreenFlag</CODE></span> 218 </th> 219<td width="100"><a href="../../../../nn_types/bit32.html"><CODE>bit32</CODE></a></td> 220<td>Flags indicating the display method for the upper screen (a bitwise OR of <a href="../../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>nn::swkbd::CTR::UpperScreenFlag</CODE></a> values).</td> 221 </tr> 222 <tr> 223 <td width="100"> </td> 224 <th> 225<span class="argument"><CODE>textCheckFlag</CODE></span> 226 </th> 227<td width="100"><a href="../../../../nn_types/bit32.html"><CODE>bit32</CODE></a></td> 228<td>Flags indicating the types of text checks (a bitwise OR of <a href="../../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>nn::swkbd::CTR::TextCheckFlag</CODE></a> values).</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233<span class="argument"><CODE>extOutputDataFlag</CODE></span> 234 </th> 235<td width="100"><a href="../../../../nn_types/bit32.html"><CODE>bit32</CODE></a></td> 236<td>Flags indicating the types of extended output data (a bitwise OR of <a href="../../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>nn::swkbd::CTR::ExtOutputDataFlag</CODE></a> values).</td> 237 </tr> 238 <tr> 239 <td width="100"> </td> 240 <th> 241<span class="argument"><CODE>textLengthMax</CODE></span> 242 </th> 243<td width="100"><a href="../../../../nn_types/u16.html">u16</a></td> 244<td>The maximum number of characters that can be input.</td> 245 </tr> 246 <tr> 247 <td width="100"> </td> 248 <th> 249<span class="argument"><CODE>numUserWords</CODE></span> 250 </th> 251<td width="100"><a href="../../../../nn_types/u16.html">u16</a></td> 252<td>The number of words to register in the user dictionary.</td> 253 </tr> 254 <tr> 255 <td width="100"> </td> 256 <th> 257<span class="argument"><CODE>numNumbersMax</CODE></span> 258 </th> 259<td width="100"><a href="../../../../nn_types/u16.html">u16</a></td> 260<td>The maximum number of numbers that can be input.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<span class="argument"><CODE>bottomButtonText</CODE></span> 266 </th> 267<td width="100"><CODE>wchar_t</CODE></td> 268<td>The text for the bottom-row buttons.</td> 269 </tr> 270 <tr> 271 <td width="100"> </td> 272 <th> 273<span class="argument"><CODE>tenkeyExtKeyChar</CODE></span> 274 </th> 275<td width="100"><CODE>wchar_t</CODE></td> 276<td>The text for the extended keys in the numeric keypad layout.</td> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281<span class="argument"><CODE>guideText</CODE></span> 282 </th> 283<td width="100"><CODE>wchar_t</CODE></td> 284<td>The guide text.</td> 285 </tr> 286 <tr> 287 <td width="100"> </td> 288 <th> 289<span class="argument"><CODE>prediction</CODE></span> 290 </th> 291<td width="100"><CODE>bool</CODE></td> 292<td>Whether to use predictive text.</td> 293 </tr> 294 <tr> 295 <td width="100"> </td> 296 <th> 297<span class="argument"><CODE>lineFeed</CODE></span> 298 </th> 299<td width="100">bool</td> 300<td>Whether to enable newlines.</td> 301 </tr> 302 <tr> 303 <td width="100"> </td> 304 <th> 305<span class="argument"><CODE>fixedWidthMode</CODE></span> 306 </th> 307<td width="100">bool</td> 308<td>Fixed-width display mode.</td> 309 </tr> 310 <tr> 311 <td width="100"> </td> 312 <th> 313<span class="argument"><CODE>homeButton</CODE></span> 314 </th> 315<td width="100">bool</td> 316<td>Whether to end the software keyboard applet when HOME is pressed.</td> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<span class="argument"><CODE>softwareReset</CODE></span> 322 </th> 323<td width="100">bool</td> 324<td>Whether to use software resets.</td> 325 </tr> 326 <tr> 327 <td width="100"> </td> 328 <th> 329<span class="argument"><CODE>powerButton</CODE></span> 330 </th> 331<td width="100">bool</td> 332<td>Whether to close the software keyboard applet when the POWER Button is pressed.</td> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337<span class="argument"><CODE>communicateWithOtherRegions</CODE></span> 338 </th> 339<td width="100">bool</td> 340<td>Whether the application exchanges data with other regions (this is not currently accessed).</td> 341 </tr> 342 <tr> 343 <td width="100"> </td> 344 <th> 345<span class="argument"><CODE>bootWithQwerty</CODE></span> 346 </th> 347<td width="100">bool</td> 348<td>Whether to make the key layout the QWERTY layout at startup.</td> 349 </tr> 350 <tr> 351 <td width="100"> </td> 352 <th> 353<span class="argument"><CODE>bottomButtonToFinish</CODE></span> 354 </th> 355<td width="100">bool</td> 356<td>Specifies an <B>OK</B> button in the bottom row of buttons.</td> 357 </tr> 358 <tr> 359 <td width="100"> </td> 360 <th> 361<span class="argument"><CODE>displayLanguage</CODE></span> 362 </th> 363<td width="100"><a href="../../../../nn/swkbd/CTR/DisplayLanguage.html"><CODE>DisplayLanguage</CODE></a></td> 364<td>The display language.</td> 365 </tr> 366 <tr> 367<th class="category" colspan="4">Input (Direct Setting Impossible)</th> 368 </tr> 369 <tr> 370 <td width="100"> </td> 371 <th> 372<span class="argument"><CODE>initialInputText</CODE></span> 373 </th> 374<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 375<td>Offset to the initial input text.</td> 376 </tr> 377 <tr> 378 <td width="100"> </td> 379 <th> 380<span class="argument"><CODE>userWordArray</CODE></span> 381 </th> 382<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 383<td>Offset to the array of words registered in the user dictionary.</td> 384 </tr> 385 <tr> 386 <td width="100"> </td> 387 <th> 388<span class="argument"><CODE>initialStatusData</CODE></span> 389 </th> 390<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 391<td>Offset to the initial operating status data at startup.</td> 392 </tr> 393 <tr> 394 <td width="100"> </td> 395 <th> 396<span class="argument"><CODE>initialLearningData</CODE></span> 397 </th> 398<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 399<td>Offset to the initial predictive text learning data at startup.</td> 400 </tr> 401 <tr> 402 <td width="100"> </td> 403 <th> 404<span class="argument"><CODE>sharedMemorySize</CODE></span> 405 </th> 406<td width="100"><CODE>size_t</CODE></td> 407<td>The size of the shared memory region.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412<span class="argument"><CODE>versionNumber</CODE></span> 413 </th> 414<td width="100"><a href="../../../../nn_types/u16.html">u16</a></td> 415<td>Version number.</td> 416 </tr> 417 <tr> 418<th class="category" colspan="4">Output</th> 419 </tr> 420 <tr> 421 <td width="100"> </td> 422 <th> 423<span class="argument"><CODE>returnCode</CODE></span> 424 </th> 425<td width="100"><a href="../../../../nn/swkbd/CTR/ReturnCode.html"><CODE>ReturnCode</CODE></a></td> 426<td>Return code.</td> 427 </tr> 428 <tr> 429 <td width="100"> </td> 430 <th> 431<span class="argument"><CODE>statusData</CODE></span> 432 </th> 433<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 434<td>Offset to the final operating status data.</td> 435 </tr> 436 <tr> 437 <td width="100"> </td> 438 <th> 439<span class="argument"><CODE>learningData</CODE></span> 440 </th> 441<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 442<td>Offset to the final predictive text learning data.</td> 443 </tr> 444 <tr> 445 <td width="100"> </td> 446 <th> 447<span class="argument"><CODE>inputText</CODE></span> 448 </th> 449<td width="100"><a href="../../../../nn_types/sptr.html"><CODE>sptr</CODE></a></td> 450<td>Offset to the entered text.</td> 451 </tr> 452 <tr> 453 <td width="100"> </td> 454 <th> 455<span class="argument"><CODE>inputTextLength</CODE></span> 456 </th> 457<td width="100"><a href="../../../../nn_types/u16.html">u16</a></td> 458<td>Length of the entered text.</td> 459 </tr> 460 <tr> 461<th class="category" colspan="4">Related to Text Checking by the Application</th> 462 </tr> 463 <tr> 464 <td width="100"> </td> 465 <th> 466<span class="argument"><CODE>appTextCheckResult</CODE></span> 467 </th> 468<td width="100"><a href="../../../../nn/swkbd/CTR/AppTextCheckResult.html"><CODE>AppTextCheckResult</CODE></a></td> 469<td>Result of the application's text checks.</td> 470 </tr> 471 <tr> 472 <td width="100"> </td> 473 <th> 474<span class="argument"><CODE>appTextCheckDialogText</CODE></span> 475 </th> 476<td width="100"><CODE>wchar_t</CODE></td> 477<td>Dialog text of the application's text checks.</td> 478 </tr> 479 <tr> 480<th class="category" colspan="4">Other</th> 481 </tr> 482 <tr> 483 <td width="100"> </td> 484 <th> 485<span class="argument"><CODE>skipAtMarkCheck</CODE></span> 486 </th> 487<td width="100">bool</td> 488<td>(Member variable for use by certain special applications. It cannot be used from general applications.)</td> 489 </tr> 490 <tr> 491 <td width="100"> </td> 492 <th> 493<span class="argument"><CODE>reserved</CODE></span> 494 </th> 495<td width="100"><a href="../../../../nn_types/u8.html"><CODE>u8</CODE></a></td> 496<td>A reserved region for future extensions.</td> 497 </tr> </table> 498 </div> 499 </a> 500<h2>Revision History</h2> 501 <div class="section"> 502 <dl class="history"> 503 <dt>2011/10/13</dt> 504<dd>Noted that the <CODE>communicateWithOtherRegions</CODE> variable is not currently accessed.<br /> 505 </dd> 506 <dt>2011/09/01</dt> 507<dd>Revised the appearance of the <B>Description</B>.<br /> 508 </dd> 509 <dt>2011/08/05</dt> 510<dd>Added the member variables <CODE>displayLanguage</CODE> and <CODE>skipAtMarkCheck</CODE>.<br /> 511 </dd> 512 <dt>2011/03/18</dt> 513<dd>Added note to description of the <CODE>bottomButtonText</CODE> member variable that the default text will be used based on the system's region and language settings.<br /> 514 </dd> 515 <dt>2011/03/01</dt> 516<dd>Initial version.<br /> 517 </dd> 518 </dl> 519 </div> 520 <hr><p>CONFIDENTIAL</p></body> 521</html> 522