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 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nn::swkbd::CTR</title> 51 </head> 52 <body> 53 <h1><CODE>nn::swkbd::CTR</CODE> Namespace</h1> 54 <h2>Description</h2> 55 <div class="section"> 56 <p>The <a href="../../../nn/swkbd/CTR/Overview.html">CTR</a> software keyboard applet API namespace. <br /> (This namespace can also be written without the <CODE>::CTR</CODE> portion.)</p><p>The <CODE>wchar_t</CODE>-type characters (or strings) handled by the software keyboard applet are all in UTF-16LE encoding, using LF newline codes. <br /> However, only characters in the BMP (<CODE>U+0000</CODE> through <CODE>U+FFFF</CODE>) are available. Characters outside the BMP are unsupported.</p><p>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.<br /> Specifics are shown below. </p><ul><li />ASCII 95 57 <li />CP 1252 58 <li />CP 1253 59 <li />ISO 8859-1 (Latin-1) 60 <li />ISO 8859-7 61 <li />JIS X0201 62 <li />JIS X0208 63 </ul><p>If you are not using predictive text input, see the document <CODE>CTR_SWKBD_characters.xls</CODE> included in this package.</p><p><B>Note:</B> 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.</p></div> 64 <a name="struct" id="struct"> 65 <h2>Structures</h2> 66 <div class="section"> 67 <table class="members"> 68 <tr> 69 <th> 70 <a href="../../../nn/swkbd/CTR/UserWord/Overview.html"><CODE>nn::swkbd::CTR::UserWord</CODE></a> 71 </th> 72 <td>Structure holding words registered in the user dictionary.</td> 73 </tr> 74 <tr> 75 <th> 76 <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>nn::swkbd::CTR::Config</CODE></a> 77 </th> 78 <td>Configuration structure.</td> 79 </tr> 80 <tr> 81 <th> 82 <a href="../../../nn/swkbd/CTR/Parameter/Overview.html"><CODE>nn::swkbd::CTR::Parameter</CODE></a> 83 </th> 84 <td>Parameter structure passed to the software keyboard applet when the applet is executed.</td> 85 </tr> </table> 86 </div> 87 </a> <a name="enum" id="enum"> 88 <h2>Enumerated Types</h2> 89 <div class="section"> 90 <table class="members"> 91 <tr> 92 <td width="100"> </td> 93 <th> 94 <a href="../../../nn/swkbd/CTR/KeyboardType.html"><CODE>KeyboardType</CODE></a> 95 </th> 96 <td>Enumerated type indicating the type of keyboard.</td> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101 <a href="../../../nn/swkbd/CTR/BottomButtonType.html"><CODE>BottomButtonType</CODE></a> 102 </th> 103 <td>Enumerated type for the type of the buttons on the bottom row.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108 <a href="../../../nn/swkbd/CTR/BottomButton.html"><CODE>BottomButton</CODE></a> 109 </th> 110 <td>Enumerated type for the index of buttons on the bottom row.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115 <a href="../../../nn/swkbd/CTR/TenkeyExtKey.html"><CODE>TenkeyExtKey</CODE></a> 116 </th> 117 <td>Enumerated type indicating the index of the numeric keypad extended keys.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122 <a href="../../../nn/swkbd/CTR/FinishableCondition.html"><CODE>FinishableCondition</CODE></a> 123 </th> 124 <td>Enumerated type indicating the conditions to be met in order to finalize the input.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129 <a href="../../../nn/swkbd/CTR/MaskMode.html"><CODE>MaskMode</CODE></a> 130 </th> 131 <td>The masking mode for input characters.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136 <a href="../../../nn/swkbd/CTR/ParentalControlsMode.html"><CODE>ParentalControlsMode</CODE></a> 137 </th> 138 <td>Temporarily-disabled modes of Parental Controls.</td> 139 </tr> 140 <tr> 141 <td width="100"> </td> 142 <th> 143 <a href="../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>UpperScreenFlag</CODE></a> 144 </th> 145 <td>Flag indicating the display method for the upper screen.</td> 146 </tr> 147 <tr> 148 <td width="100"> </td> 149 <th> 150 <a href="../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>TextCheckFlag</CODE></a> 151 </th> 152 <td>Flags indicating the types of text checks.</td> 153 </tr> 154 <tr> 155 <td width="100"> </td> 156 <th> 157 <a href="../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>ExtOutputDataFlag</CODE></a> 158 </th> 159 <td>Flag indicating the type of the extended output data.</td> 160 </tr> 161 <tr> 162 <td width="100"> </td> 163 <th> 164 <a href="../../../nn/swkbd/CTR/AppTextCheckResult.html"><CODE>AppTextCheckResult</CODE></a> 165 </th> 166 <td>Result of the application's text check.</td> 167 </tr> 168 <tr> 169 <td width="100"> </td> 170 <th> 171 <a href="../../../nn/swkbd/CTR/ReturnCode.html"><CODE>ReturnCode</CODE></a> 172 </th> 173 <td>Return codes.</td> 174 </tr> </table> 175 </div> 176 </a> <a name="typedef" id="typedef"> 177 <h2><CODE>typedef</CODE> Definitions</h2> 178 <div class="section"> 179 <table class="members"> 180 <tr> 181 <td width="100" /> 182 <th> 183 <a href="../../../nn/swkbd/CTR/AppTextCheckCallback.html"><CODE>AppTextCheckCallback</CODE></a> 184 </th> 185 <td>Function type that indicates the callback for text checking performed by the application.</td> 186 </tr> </table> 187 </div> 188 </a> <a name="constant" id="constant"> 189 <h2>Constants</h2> 190 <div class="section"> 191 <table class="members"> 192 <tr> 193 <td width="100"> </td> 194 <th> 195 <span class="argument"><a href="../../../nn/swkbd/CTR/VERSION_NUMBER.html"><CODE>VERSION_NUMBER</CODE></a></span> 196 </th> 197 <td>The version number.</td> 198 </tr> 199 <tr> 200 <td width="100"> </td> 201 <th> 202 <span class="argument"><a href="../../../nn/swkbd/CTR/STATUS_DATA_SIZE.html"><CODE>STATUS_DATA_SIZE</CODE></a></span> 203 </th> 204 <td>Size of the operating status data.</td> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209 <span class="argument"><a href="../../../nn/swkbd/CTR/LEARNING_DATA_SIZE.html"><CODE>LEARNING_DATA_SIZE</CODE></a></span> 210 </th> 211 <td>Size of the predictive text learning data.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216 <span class="argument"><a href="../../../nn/swkbd/CTR/TEXT_LENGTH_MAX_MIN.html"><CODE>TEXT_LENGTH_MAX_MIN</CODE></a></span> 217 </th> 218 <td>The minimum value for the maximum number of characters that can be input.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223 <span class="argument"><a href="../../../nn/swkbd/CTR/TEXT_LENGTH_MAX_MAX.html"><CODE>TEXT_LENGTH_MAX_MAX</CODE></a></span> 224 </th> 225 <td>The maximum value for the maximum number of characters that can be input.</td> 226 </tr> 227 <tr> 228 <td width="100"> </td> 229 <th> 230 <span class="argument"><a href="../../../nn/swkbd/CTR/FIXED_WIDTH_TEXT_LENGTH_MAX_MAX.html"><CODE>FIXED_WIDTH_TEXT_LENGTH_MAX_MAX</CODE></a></span> 231 </th> 232 <td>The maximum value of the maximum number of characters that can be input when the display mode is fixed-width.</td> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237 <span class="argument"><a href="../../../nn/swkbd/CTR/TEXT_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>TEXT_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a></span> 238 </th> 239 <td>The maximum value for the maximum number of characters that can be input when text is being checked.</td> 240 </tr> 241 <tr> 242 <td width="100"> </td> 243 <th> 244 <span class="argument"><a href="../../../nn/swkbd/CTR/BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a></span> 245 </th> 246 <td>The maximum value of the maximum number of characters that can be entered when profanity input is prohibited.</td> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251 <span class="argument"><a href="../../../nn/swkbd/CTR/BOTTOM_BUTTON_TEXT_LENGTH_MAX.html"><CODE>BOTTOM_BUTTON_TEXT_LENGTH_MAX</CODE></a></span> 252 </th> 253 <td>The maximum number of text characters for the bottom row of buttons.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258 <span class="argument"><a href="../../../nn/swkbd/CTR/GUIDE_TEXT_LENGTH_MAX.html"><CODE>GUIDE_TEXT_LENGTH_MAX</CODE></a></span> 259 </th> 260 <td>The maximum number of guide text characters.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265 <span class="argument"><a href="../../../nn/swkbd/CTR/APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX.html"><CODE>APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX</CODE></a></span> 266 </th> 267 <td>The maximum number of text characters in the application's text check dialog.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272 <span class="argument"><a href="../../../nn/swkbd/CTR/NUM_USER_WORDS_MAX.html"><CODE>NUM_USER_WORDS_MAX</CODE></a></span> 273 </th> 274 <td>The maximum number of words that can be registered in the user dictionary per each single language.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279 <span class="argument"><a href="../../../nn/swkbd/CTR/USER_WORD_LENGTH_MAX.html"><CODE>USER_WORD_LENGTH_MAX</CODE></a></span> 280 </th> 281 <td>The maximum number of characters in words that can be registered to the user dictionary.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286 <span class="argument"><a href="../../../nn/swkbd/CTR/USER_READING_LENGTH_MAX.html"><CODE>USER_READING_LENGTH_MAX</CODE></a></span> 287 </th> 288 <td>The maximum number of characters in the reading of a word registered to the user dictionary.</td> 289 </tr> </table> 290 </div> 291 </a> <a name="function" id="function"> 292 <h2>Functions</h2> 293 <div class="section"> 294 <table class="members"> 295 <tr> 296 <td width="100"> </td> 297 <th> 298 <a href="../../../nn/swkbd/CTR/InitializeConfig.html"><CODE>InitializeConfig</CODE></a> 299 </th> 300 <td>Initializes the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure to default values.</td> 301 </tr> 302 <tr> 303 <td width="100"> </td> 304 <th> 305 <a href="../../../nn/swkbd/CTR/GetSharedMemorySize.html"><CODE>GetSharedMemorySize</CODE></a> 306 </th> 307 <td>Calculates the size of the necessary shared memory region from the settings of the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure.</td> 308 </tr> 309 <tr> 310 <td width="100"> </td> 311 <th> 312 <a href="../../../nn/swkbd/CTR/PreloadKeyboardApplet.html"><CODE>PreloadKeyboardApplet</CODE></a> 313 </th> 314 <td>Preloads the software keyboard applet.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319 <a href="../../../nn/swkbd/CTR/CancelPreloadKeyboardApplet.html"><CODE>CancelPreloadKeyboardApplet</CODE></a> 320 </th> 321 <td>Cancels the preloading of the software keyboard applet.</td> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326 <a href="../../../nn/swkbd/CTR/WaitForPreloadKeyboardApplet.html"><CODE>WaitForPreloadKeyboardApplet</CODE></a> 327 </th> 328 <td>Waits for the completion of preloading of the software keyboard applet.</td> 329 </tr> 330 <tr> 331 <td width="100"> </td> 332 <th> 333 <a href="../../../nn/swkbd/CTR/IsRegisteredKeyboardApplet.html"><CODE>IsRegisteredKeyboardApplet</CODE></a> 334 </th> 335 <td>Checks whether preload of the software keyboard applet is complete.</td> 336 </tr> 337 <tr> 338 <td width="100"> </td> 339 <th> 340 <a href="../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>StartKeyboardApplet</CODE></a> 341 </th> 342 <td>Starts up the software keyboard applet.</td> 343 </tr> </table> 344 </div> 345 </a> 346 <h2>Revision History</h2> 347 <div class="section"> 348 <dl class="history"> 349 <dt>2011/03/01</dt> 350 <dd>Initial version.<br /> 351 </dd> 352 </dl> 353 </div> 354 <hr><p>CONFIDENTIAL</p></body> 355</html>