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><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/swkbd/Overview.html">swkbd</a>::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>The namespace of the applet call-up library for the <a href="../../../nn/swkbd/CTR/Overview.html">CTR</a> software keyboard.<br /> (This namespace can also be written without the <CODE>::CTR</CODE> part.)</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><B>Note:</B> Thread priorities 17 through 20 are used by software keyboard applet threads. Take this into consideration if your application sets priorities for threads that continue to run while the keyboard applet is running.</p><p> 57If the version of the software keyboard applet library used by the application does not match the SDK version supported by the System Updater in use, the software keyboard applet will sometimes fail to launch. If the software keyboard applet does not launch, apply the most recent System Updater. 58 </p></div> 59 <a name="struct" id="struct"> 60<h2>Structures</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <th> 65<a href="../../../nn/swkbd/CTR/UserWord/Overview.html"><CODE>nn::swkbd::CTR::UserWord</CODE></a> 66 </th> 67<td>Structure for a word registered in the user dictionary.</td> 68 </tr> 69 <tr> 70 <th> 71<a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>nn::swkbd::CTR::Config</CODE></a> 72 </th> 73<td>Configuration structure.</td> 74 </tr> 75 <tr> 76 <th> 77<a href="../../../nn/swkbd/CTR/Parameter/Overview.html"><CODE>nn::swkbd::CTR::Parameter</CODE></a> 78 </th> 79<td>Parameter structure to pass to the software keyboard applet when it executes.</td> 80 </tr> </table> 81 </div> 82 </a> <a name="enum" id="enum"> 83<h2>Enumerated Types</h2> 84 <div class="section"> 85 <table class="members"> 86 <tr> 87 <td width="100"> </td> 88 <th> 89<a href="../../../nn/swkbd/CTR/KeyboardType.html"><CODE>KeyboardType</CODE></a> 90 </th> 91<td>Enumerated type indicating the type of keyboard.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96<a href="../../../nn/swkbd/CTR/BottomButtonType.html"><CODE>BottomButtonType</CODE></a> 97 </th> 98<td>Enumerated type for the types of buttons on the bottom row.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103<a href="../../../nn/swkbd/CTR/BottomButton.html"><CODE>BottomButton</CODE></a> 104 </th> 105<td>Enumerated type for the indices of the buttons on the bottom row.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110<a href="../../../nn/swkbd/CTR/TenkeyExtKey.html"><CODE>TenkeyExtKey</CODE></a> 111 </th> 112<td>Enumerated type indicating the index of the numeric keypad extended keys.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117<a href="../../../nn/swkbd/CTR/FinishableCondition.html"><CODE>FinishableCondition</CODE></a> 118 </th> 119<td>Enumerated type for conditions under which input can be finalized.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124<a href="../../../nn/swkbd/CTR/MaskMode.html"><CODE>MaskMode</CODE></a> 125 </th> 126<td>Enumerated type that indicates the masking mode for input characters.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131<a href="../../../nn/swkbd/CTR/ParentalControlsMode.html"><CODE>ParentalControlsMode</CODE></a> 132 </th> 133<td>Enumerated type that represents the modes for temporarily disabling Parental Controls.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138<a href="../../../nn/swkbd/CTR/DisplayLanguage.html"><CODE>DisplayLanguage</CODE></a> 139 </th> 140<td>Enumerated type indicating the display language.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<a href="../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>UpperScreenFlag</CODE></a> 146 </th> 147<td>Flag indicating the display method for the upper screen.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152<a href="../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>TextCheckFlag</CODE></a> 153 </th> 154<td>Flags indicating the types of text checks.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<a href="../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>ExtOutputDataFlag</CODE></a> 160 </th> 161<td>Flags indicating the types of extended output data.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166<a href="../../../nn/swkbd/CTR/AppTextCheckResult.html"><CODE>AppTextCheckResult</CODE></a> 167 </th> 168<td>Enumerated type that indicates the result of text checking by the application.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173<a href="../../../nn/swkbd/CTR/ReturnCode.html"><CODE>ReturnCode</CODE></a> 174 </th> 175<td>Enumerated type representing return codes.</td> 176 </tr> </table> 177 </div> 178 </a> <a name="typedef" id="typedef"> 179<h2><CODE>typedef</CODE> Definitions</h2> 180 <div class="section"> 181 <table class="members"> 182 <tr> 183 <td width="100" /> 184 <th> 185<a href="../../../nn/swkbd/CTR/AppTextCheckCallback.html"><CODE>AppTextCheckCallback</CODE></a> 186 </th> 187<td>Function type representing the callback for text checking performed by the application.</td> 188 </tr> </table> 189 </div> 190 </a> <a name="constant" id="constant"> 191<h2>Constants</h2> 192 <div class="section"> 193 <table class="members"> 194 <tr> 195 <td width="100"> </td> 196 <th> 197<span class="argument"><a href="../../../nn/swkbd/CTR/VERSION_NUMBER.html"><CODE>VERSION_NUMBER</CODE></a></span> 198 </th> 199<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 200<td>Version number.</td> 201 </tr> 202 <tr> 203 <td width="100"> </td> 204 <th> 205<span class="argument"><a href="../../../nn/swkbd/CTR/STATUS_DATA_SIZE.html"><CODE>STATUS_DATA_SIZE</CODE></a></span> 206 </th> 207<td width="100"><CODE>const size_t</CODE></td> 208<td>Size of the operating status data.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213<span class="argument"><a href="../../../nn/swkbd/CTR/LEARNING_DATA_SIZE.html"><CODE>LEARNING_DATA_SIZE</CODE></a></span> 214 </th> 215<td width="100"><CODE>const size_t</CODE></td> 216<td>Size of the predictive text learning data.</td> 217 </tr> 218 <tr> 219 <td width="100"> </td> 220 <th> 221<span class="argument"><a href="../../../nn/swkbd/CTR/TEXT_LENGTH_MAX_MIN.html"><CODE>TEXT_LENGTH_MAX_MIN</CODE></a></span> 222 </th> 223<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 224<td>The minimum value for the maximum number of characters that can be input.</td> 225 </tr> 226 <tr> 227 <td width="100"> </td> 228 <th> 229<span class="argument"><a href="../../../nn/swkbd/CTR/TEXT_LENGTH_MAX_MAX.html"><CODE>TEXT_LENGTH_MAX_MAX</CODE></a></span> 230 </th> 231<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 232<td>The maximum value for the maximum number of characters that can be input.</td> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237<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> 238 </th> 239<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 240<td>The maximum value for the maximum number of characters that can be input in fixed-width display mode.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245<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> 246 </th> 247<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 248<td>The maximum value for the maximum number of characters that can be input when text is being checked.</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253<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> 254 </th> 255<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 256<td>The maximum value for the maximum number of characters that can be entered when input of profanity is prohibited.</td> 257 </tr> 258 <tr> 259 <td width="100"> </td> 260 <th> 261<span class="argument"><a href="../../../nn/swkbd/CTR/BOTTOM_BUTTON_TEXT_LENGTH_MAX.html"><CODE>BOTTOM_BUTTON_TEXT_LENGTH_MAX</CODE></a></span> 262 </th> 263<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 264<td>The maximum number of characters for the text in the bottom row of buttons.</td> 265 </tr> 266 <tr> 267 <td width="100"> </td> 268 <th> 269<span class="argument"><a href="../../../nn/swkbd/CTR/GUIDE_TEXT_LENGTH_MAX.html"><CODE>GUIDE_TEXT_LENGTH_MAX</CODE></a></span> 270 </th> 271<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 272<td>The maximum number of characters in guide text.</td> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277<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> 278 </th> 279<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 280<td>The maximum number of characters in the text of the application's text checking dialog.</td> 281 </tr> 282 <tr> 283 <td width="100"> </td> 284 <th> 285<span class="argument"><a href="../../../nn/swkbd/CTR/NUM_USER_WORDS_MAX.html"><CODE>NUM_USER_WORDS_MAX</CODE></a></span> 286 </th> 287<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 288<td>The maximum number of words that can be registered in the user dictionary for each single language.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<span class="argument"><a href="../../../nn/swkbd/CTR/USER_WORD_LENGTH_MAX.html"><CODE>USER_WORD_LENGTH_MAX</CODE></a></span> 294 </th> 295<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 296<td>The maximum number of characters for a word that can be registered to the user dictionary.</td> 297 </tr> 298 <tr> 299 <td width="100"> </td> 300 <th> 301<span class="argument"><a href="../../../nn/swkbd/CTR/USER_READING_LENGTH_MAX.html"><CODE>USER_READING_LENGTH_MAX</CODE></a></span> 302 </th> 303<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 304<td>The maximum number of characters in the reading of a word registered to the user dictionary.</td> 305 </tr> </table> 306 </div> 307 </a> <a name="function" id="function"> 308<h2>Functions</h2> 309 <div class="section"> 310 <table class="members"> 311 <tr> 312 <td width="100"> </td> 313 <th> 314<a href="../../../nn/swkbd/CTR/InitializeConfig.html"><CODE>InitializeConfig</CODE></a> 315 </th> 316<td>Initializes the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure to default values.</td> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<a href="../../../nn/swkbd/CTR/GetSharedMemorySize.html"><CODE>GetSharedMemorySize</CODE></a> 322 </th> 323<td>Calculates the size of the necessary shared memory region based on the settings in the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328<a href="../../../nn/swkbd/CTR/PreloadKeyboardApplet.html"><CODE>PreloadKeyboardApplet</CODE></a> 329 </th> 330<td>Preloads the software keyboard applet.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335<a href="../../../nn/swkbd/CTR/CancelPreloadKeyboardApplet.html"><CODE>CancelPreloadKeyboardApplet</CODE></a> 336 </th> 337<td>Cancels the preloading of the software keyboard applet.</td> 338 </tr> 339 <tr> 340 <td width="100"> </td> 341 <th> 342<a href="../../../nn/swkbd/CTR/WaitForPreloadKeyboardApplet.html"><CODE>WaitForPreloadKeyboardApplet</CODE></a> 343 </th> 344<td>Waits for the completion of preloading of the software keyboard applet.</td> 345 </tr> 346 <tr> 347 <td width="100"> </td> 348 <th> 349<a href="../../../nn/swkbd/CTR/IsRegisteredKeyboardApplet.html"><CODE>IsRegisteredKeyboardApplet</CODE></a> 350 </th> 351<td>Checks whether preload of the software keyboard applet is complete.</td> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356<a href="../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>StartKeyboardApplet</CODE></a> 357 </th> 358<td>Starts up the software keyboard applet.</td> 359 </tr> </table> 360 </div> 361 </a> 362<h2>Revision History</h2> 363 <div class="section"> 364 <dl class="history"> 365 <dt>2011/10/07</dt> 366<dd>Moved a description of the types of characters used by the software keyboard to the <I>Specifications for System Applications and Applets</I>.<br /> 367 </dd> 368 <dt>2011/03/01</dt> 369<dd>Initial version.<br /> 370 </dd> 371 </dl> 372 </div> 373 <hr><p>CONFIDENTIAL</p></body> 374</html> 375