1281 lines
76 KiB
HTML
1281 lines
76 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/applets/swkbd.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_1c7e2ffa4b11c2c27de6db7f8722520d.html">applets</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">swkbd.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Software keyboard applet.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">3ds/types.h</a>></code><br />
|
|
</div>
|
|
<p><a href="swkbd_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSwkbdDictWord.html">SwkbdDictWord</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard dictionary word for predictive input. <a href="structSwkbdDictWord.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSwkbdStatusData.html">SwkbdStatusData</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard status data. <a href="structSwkbdStatusData.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSwkbdLearningData.html">SwkbdLearningData</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard predictive input learning data. <a href="structSwkbdLearningData.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSwkbdExtra.html">SwkbdExtra</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal libctru book-keeping structure for software keyboards. <a href="structSwkbdExtra.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSwkbdState.html">SwkbdState</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Software keyboard parameter structure, it shouldn't be modified directly. <a href="structSwkbdState.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:af46520bdb45806063c4f63cd7d19adce"><td class="memItemLeft" align="right" valign="top"><a id="af46520bdb45806063c4f63cd7d19adce"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#af46520bdb45806063c4f63cd7d19adce">SWKBD_MAX_WORD_LEN</a>   40</td></tr>
|
|
<tr class="memdesc:af46520bdb45806063c4f63cd7d19adce"><td class="mdescLeft"> </td><td class="mdescRight">Maximum dictionary word length, in UTF-16 code units. <br /></td></tr>
|
|
<tr class="separator:af46520bdb45806063c4f63cd7d19adce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaadedc4dededc44c16c56c71da120298"><td class="memItemLeft" align="right" valign="top"><a id="aaadedc4dededc44c16c56c71da120298"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#aaadedc4dededc44c16c56c71da120298">SWKBD_MAX_BUTTON_TEXT_LEN</a>   16</td></tr>
|
|
<tr class="memdesc:aaadedc4dededc44c16c56c71da120298"><td class="mdescLeft"> </td><td class="mdescRight">Maximum button text length, in UTF-16 code units. <br /></td></tr>
|
|
<tr class="separator:aaadedc4dededc44c16c56c71da120298"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52cbc334c24512e60befe6f7a57f33c4"><td class="memItemLeft" align="right" valign="top"><a id="a52cbc334c24512e60befe6f7a57f33c4"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a52cbc334c24512e60befe6f7a57f33c4">SWKBD_MAX_HINT_TEXT_LEN</a>   64</td></tr>
|
|
<tr class="memdesc:a52cbc334c24512e60befe6f7a57f33c4"><td class="mdescLeft"> </td><td class="mdescRight">Maximum hint text length, in UTF-16 code units. <br /></td></tr>
|
|
<tr class="separator:a52cbc334c24512e60befe6f7a57f33c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a151b6133d35cee6517b85dd9a03cc170"><td class="memItemLeft" align="right" valign="top"><a id="a151b6133d35cee6517b85dd9a03cc170"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a151b6133d35cee6517b85dd9a03cc170">SWKBD_MAX_CALLBACK_MSG_LEN</a>   256</td></tr>
|
|
<tr class="memdesc:a151b6133d35cee6517b85dd9a03cc170"><td class="mdescLeft"> </td><td class="mdescRight">Maximum filter callback error message length, in UTF-16 code units. <br /></td></tr>
|
|
<tr class="separator:a151b6133d35cee6517b85dd9a03cc170"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:aa399c3ac23cdac010f1391caaeb3239c"><td class="memItemLeft" align="right" valign="top"><a id="aa399c3ac23cdac010f1391caaeb3239c"></a>
|
|
typedef <a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7a">SwkbdCallbackResult</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#aa399c3ac23cdac010f1391caaeb3239c">SwkbdCallbackFn</a>) (void *user, const char **ppMessage, const char *text, size_t textlen)</td></tr>
|
|
<tr class="memdesc:aa399c3ac23cdac010f1391caaeb3239c"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard filter callback function. <br /></td></tr>
|
|
<tr class="separator:aa399c3ac23cdac010f1391caaeb3239c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ad88d214560b9bbaf1391cc7013ab4387"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387">SwkbdType</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387a09e29e270f59d0b17f06c8455d6a836c">SWKBD_TYPE_NORMAL</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387afb5f26b787995fc4b88a1668e4a99c09">SWKBD_TYPE_QWERTY</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387a5802f3a1eabee6305045ed5cd57ae5b9">SWKBD_TYPE_NUMPAD</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387a0f871d4bbdd45581d73f4877fafdb002">SWKBD_TYPE_WESTERN</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ad88d214560b9bbaf1391cc7013ab4387"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard types. <a href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387">More...</a><br /></td></tr>
|
|
<tr class="separator:ad88d214560b9bbaf1391cc7013ab4387"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c2863f4e484d07ba6be8fdf84bb96a1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1">SwkbdValidInput</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1adf5ca7a645dea83448551248be05bc35">SWKBD_ANYTHING</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1a9d1709266de5138ac0a0fb415b62935e">SWKBD_NOTEMPTY</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1a1caa32cefb6ab95f86a42b4dbd137feb">SWKBD_NOTEMPTY_NOTBLANK</a>
|
|
, <br />
|
|
  <b>SWKBD_NOTBLANK_NOTEMPTY</b> = SWKBD_NOTEMPTY_NOTBLANK
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1a1025cd177247c0b2482c0bbac789f798">SWKBD_NOTBLANK</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1a39be8bd578ff7ffad04190228e60a1a9">SWKBD_FIXEDLEN</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a9c2863f4e484d07ba6be8fdf84bb96a1"><td class="mdescLeft"> </td><td class="mdescRight">Accepted input types. <a href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c2863f4e484d07ba6be8fdf84bb96a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94ea720afdaf86a4be385aa913c6a29c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29ca04b5951221df3ade6e04447b590d1fd4">SWKBD_BUTTON_LEFT</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29ca7fbeb491bb84654eabad38826a00edd5">SWKBD_BUTTON_MIDDLE</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29ca2754579a6b7bf2b751751b5a9ca8c4b3">SWKBD_BUTTON_RIGHT</a>
|
|
, <br />
|
|
  <b>SWKBD_BUTTON_CONFIRM</b> = SWKBD_BUTTON_RIGHT
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29caa7a4d5142a471089f281173d35f52675">SWKBD_BUTTON_NONE</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a94ea720afdaf86a4be385aa913c6a29c"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard dialog buttons. <a href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">More...</a><br /></td></tr>
|
|
<tr class="separator:a94ea720afdaf86a4be385aa913c6a29c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dddf239d1add2f4a68d79ca0e64c1b9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9">SwkbdPasswordMode</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9aa862068a3d6d1d30c9c2343025368d56">SWKBD_PASSWORD_NONE</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9a1da6c004e85d5d11b798c5805ea2f3dc">SWKBD_PASSWORD_HIDE</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9aa2ec3ada05cfa6de081da8288635d110">SWKBD_PASSWORD_HIDE_DELAY</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a7dddf239d1add2f4a68d79ca0e64c1b9"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard password modes. <a href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7dddf239d1add2f4a68d79ca0e64c1b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99fb83031ce9923c84392b4e92f956b5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5aa03c93ae6d25484d672a409bec1c79ef">SWKBD_FILTER_DIGITS</a> = BIT(0)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5a556df4c35b36612b092e414600e30eed">SWKBD_FILTER_AT</a> = BIT(1)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5ab4a359ee3ad3a4394c186bd6ba676d37">SWKBD_FILTER_PERCENT</a> = BIT(2)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5a8385e631b1b3313c05a2f80097021af6">SWKBD_FILTER_BACKSLASH</a> = BIT(3)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5a241d66f1b98f9de0da217356d5b2e4bf">SWKBD_FILTER_PROFANITY</a> = BIT(4)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5a791a253769fb274e58d0edc5b69f44c5">SWKBD_FILTER_CALLBACK</a> = BIT(5)
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a99fb83031ce9923c84392b4e92f956b5"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard input filtering flags. <a href="swkbd_8h.html#a99fb83031ce9923c84392b4e92f956b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a99fb83031ce9923c84392b4e92f956b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc6126af1d45847bc59afa0aa3216b04"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04a70304b094e5acd73deb9bb8b27128e7a">SWKBD_PARENTAL</a> = BIT(0)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04ab7aec191ef2d5df62291a011f5c0a4e7">SWKBD_DARKEN_TOP_SCREEN</a> = BIT(1)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04adf8b88dbe0a36d524a5cde8e7af45bd4">SWKBD_PREDICTIVE_INPUT</a> = BIT(2)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04ab38ff5f2098240b8fc288a0df7b41ac5">SWKBD_MULTILINE</a> = BIT(3)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04aae3631524844bce7fb3aceb10416391f">SWKBD_FIXED_WIDTH</a> = BIT(4)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04aac6fa4f37d2db0c7ee8a0b247ebc2cf1">SWKBD_ALLOW_HOME</a> = BIT(5)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04a82d4882b4e8e601e82dbf301be793e0e">SWKBD_ALLOW_RESET</a> = BIT(6)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04a22cc81cb2524dbcedf88ecd51d6174e4">SWKBD_ALLOW_POWER</a> = BIT(7)
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04ac44a4dee33fa25059f283be8e241fc62">SWKBD_DEFAULT_QWERTY</a> = BIT(9)
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:abc6126af1d45847bc59afa0aa3216b04"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard features. <a href="swkbd_8h.html#abc6126af1d45847bc59afa0aa3216b04">More...</a><br /></td></tr>
|
|
<tr class="separator:abc6126af1d45847bc59afa0aa3216b04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12d91ff65b198511e8d26960577d2c7a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7a">SwkbdCallbackResult</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7aaec9de9f165d0d788152aa5d3dfc21327">SWKBD_CALLBACK_OK</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7aa9238474d1113e68576271d5c1e87aa2c">SWKBD_CALLBACK_CLOSE</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7aaf65d5b95476c302b9201d1278761275b">SWKBD_CALLBACK_CONTINUE</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a12d91ff65b198511e8d26960577d2c7a"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard filter callback return values. <a href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7a">More...</a><br /></td></tr>
|
|
<tr class="separator:a12d91ff65b198511e8d26960577d2c7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa02a4a80747eb05ddb85235a0a41ee93"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93">SwkbdResult</a> { <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a59071ee22605a66a8ca2700a9c1ae77d">SWKBD_NONE</a> = -1
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93abd740c8d864f5c00d81c1cf31144eaef">SWKBD_INVALID_INPUT</a> = -2
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93aaac828716362cc53057fbcaf731b2c25">SWKBD_OUTOFMEM</a> = -3
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a76d54e4492757452c7c20aad596bc037">SWKBD_D0_CLICK</a> = 0
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93aecf7620ac2b17d05dd2583785e4fe67d">SWKBD_D1_CLICK0</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93ac39a32d53c9e3f20017492d0b521a936">SWKBD_D1_CLICK1</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a0225d1a05505f3439832d3a5b6c12095">SWKBD_D2_CLICK0</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a9761ef300b084cda9feff81657bb3783">SWKBD_D2_CLICK1</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a199451004dc9755c37f34cba29089817">SWKBD_D2_CLICK2</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93aac0b81dd3cf9855a464ae1429d4dde44">SWKBD_HOMEPRESSED</a> = 10
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a76e7d6d7ebf659dd635fb8ca4cfa919b">SWKBD_RESETPRESSED</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93aa4458c14c72bfd33d3bd1c1c832bef00">SWKBD_POWERPRESSED</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a1ed59bc024b62a5b6c075dfc8a0534d6">SWKBD_PARENTAL_OK</a> = 20
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93af5061a0c471654f4dd68cc59519f7188">SWKBD_PARENTAL_FAIL</a>
|
|
, <br />
|
|
  <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93a2b71a09c9b94f64e6f51cb927646c8eb">SWKBD_BANNED_INPUT</a> = 30
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:aa02a4a80747eb05ddb85235a0a41ee93"><td class="mdescLeft"> </td><td class="mdescRight">Keyboard return values. <a href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93">More...</a><br /></td></tr>
|
|
<tr class="separator:aa02a4a80747eb05ddb85235a0a41ee93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ac3a6569aa3150430e729b328999561ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#ac3a6569aa3150430e729b328999561ed">swkbdInit</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387">SwkbdType</a> type, int numButtons, int maxTextLength)</td></tr>
|
|
<tr class="memdesc:ac3a6569aa3150430e729b328999561ed"><td class="mdescLeft"> </td><td class="mdescRight">Initializes software keyboard status. <a href="swkbd_8h.html#ac3a6569aa3150430e729b328999561ed">More...</a><br /></td></tr>
|
|
<tr class="separator:ac3a6569aa3150430e729b328999561ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94b68f3e03958c2a609458641be484a2"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a94b68f3e03958c2a609458641be484a2">swkbdSetPasswordMode</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9">SwkbdPasswordMode</a> mode)</td></tr>
|
|
<tr class="memdesc:a94b68f3e03958c2a609458641be484a2"><td class="mdescLeft"> </td><td class="mdescRight">Configures password mode in a software keyboard. <a href="swkbd_8h.html#a94b68f3e03958c2a609458641be484a2">More...</a><br /></td></tr>
|
|
<tr class="separator:a94b68f3e03958c2a609458641be484a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98b664f7bc103e24ef0402e16bfc3dbf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a98b664f7bc103e24ef0402e16bfc3dbf">swkbdSetValidation</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1">SwkbdValidInput</a> validInput, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> filterFlags, int maxDigits)</td></tr>
|
|
<tr class="memdesc:a98b664f7bc103e24ef0402e16bfc3dbf"><td class="mdescLeft"> </td><td class="mdescRight">Configures input validation in a software keyboard. <a href="swkbd_8h.html#a98b664f7bc103e24ef0402e16bfc3dbf">More...</a><br /></td></tr>
|
|
<tr class="separator:a98b664f7bc103e24ef0402e16bfc3dbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad00d7ebd131e5171fca3beddace66890"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#ad00d7ebd131e5171fca3beddace66890">swkbdSetNumpadKeys</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, int left, int right)</td></tr>
|
|
<tr class="memdesc:ad00d7ebd131e5171fca3beddace66890"><td class="mdescLeft"> </td><td class="mdescRight">Configures what characters will the two bottom keys in a numpad produce. <a href="swkbd_8h.html#ad00d7ebd131e5171fca3beddace66890">More...</a><br /></td></tr>
|
|
<tr class="separator:ad00d7ebd131e5171fca3beddace66890"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ab5f470b1bde4cc7d8ea7336c078098"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a7ab5f470b1bde4cc7d8ea7336c078098">swkbdSetFeatures</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> features)</td></tr>
|
|
<tr class="memdesc:a7ab5f470b1bde4cc7d8ea7336c078098"><td class="mdescLeft"> </td><td class="mdescRight">Specifies which special features are enabled in a software keyboard. <a href="swkbd_8h.html#a7ab5f470b1bde4cc7d8ea7336c078098">More...</a><br /></td></tr>
|
|
<tr class="separator:a7ab5f470b1bde4cc7d8ea7336c078098"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab50d59110e5920e1aba641b607900277"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#ab50d59110e5920e1aba641b607900277">swkbdSetHintText</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, const char *text)</td></tr>
|
|
<tr class="memdesc:ab50d59110e5920e1aba641b607900277"><td class="mdescLeft"> </td><td class="mdescRight">Sets the hint text of a software keyboard (that is, the help text that is displayed when the textbox is empty). <a href="swkbd_8h.html#ab50d59110e5920e1aba641b607900277">More...</a><br /></td></tr>
|
|
<tr class="separator:ab50d59110e5920e1aba641b607900277"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03c1c95303c37468bda0077e8d986e00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a03c1c95303c37468bda0077e8d986e00">swkbdSetButton</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a> button, const char *text, bool submit)</td></tr>
|
|
<tr class="memdesc:a03c1c95303c37468bda0077e8d986e00"><td class="mdescLeft"> </td><td class="mdescRight">Configures a dialog button in a software keyboard. <a href="swkbd_8h.html#a03c1c95303c37468bda0077e8d986e00">More...</a><br /></td></tr>
|
|
<tr class="separator:a03c1c95303c37468bda0077e8d986e00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3188c3c8f62da1f740e195976dcabf1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a3188c3c8f62da1f740e195976dcabf1f">swkbdSetInitialText</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, const char *text)</td></tr>
|
|
<tr class="memdesc:a3188c3c8f62da1f740e195976dcabf1f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial text that a software keyboard will display on launch. <a href="swkbd_8h.html#a3188c3c8f62da1f740e195976dcabf1f">More...</a><br /></td></tr>
|
|
<tr class="separator:a3188c3c8f62da1f740e195976dcabf1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7abf5422dcf03764ffba1eaaca8c1653"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a7abf5422dcf03764ffba1eaaca8c1653">swkbdSetDictWord</a> (<a class="el" href="structSwkbdDictWord.html">SwkbdDictWord</a> *word, const char *reading, const char *text)</td></tr>
|
|
<tr class="memdesc:a7abf5422dcf03764ffba1eaaca8c1653"><td class="mdescLeft"> </td><td class="mdescRight">Configures a word in a predictive dictionary for use with a software keyboard. <a href="swkbd_8h.html#a7abf5422dcf03764ffba1eaaca8c1653">More...</a><br /></td></tr>
|
|
<tr class="separator:a7abf5422dcf03764ffba1eaaca8c1653"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8c2bcf30bd16119cab4a58c15d85495"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#ad8c2bcf30bd16119cab4a58c15d85495">swkbdSetDictionary</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, const <a class="el" href="structSwkbdDictWord.html">SwkbdDictWord</a> *dict, int wordCount)</td></tr>
|
|
<tr class="memdesc:ad8c2bcf30bd16119cab4a58c15d85495"><td class="mdescLeft"> </td><td class="mdescRight">Sets the custom word dictionary to be used with the predictive input system of a software keyboard. <a href="swkbd_8h.html#ad8c2bcf30bd16119cab4a58c15d85495">More...</a><br /></td></tr>
|
|
<tr class="separator:ad8c2bcf30bd16119cab4a58c15d85495"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97006a5ab548ac7dc1db471286b157ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a97006a5ab548ac7dc1db471286b157ba">swkbdSetStatusData</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="structSwkbdStatusData.html">SwkbdStatusData</a> *data, bool in, bool out)</td></tr>
|
|
<tr class="memdesc:a97006a5ab548ac7dc1db471286b157ba"><td class="mdescLeft"> </td><td class="mdescRight">Configures software keyboard internal status management. <a href="swkbd_8h.html#a97006a5ab548ac7dc1db471286b157ba">More...</a><br /></td></tr>
|
|
<tr class="separator:a97006a5ab548ac7dc1db471286b157ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a790328be559c7d75558faa7a5b055d2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a790328be559c7d75558faa7a5b055d2c">swkbdSetLearningData</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="structSwkbdLearningData.html">SwkbdLearningData</a> *data, bool in, bool out)</td></tr>
|
|
<tr class="memdesc:a790328be559c7d75558faa7a5b055d2c"><td class="mdescLeft"> </td><td class="mdescRight">Configures software keyboard predictive input learning data management. <a href="swkbd_8h.html#a790328be559c7d75558faa7a5b055d2c">More...</a><br /></td></tr>
|
|
<tr class="separator:a790328be559c7d75558faa7a5b055d2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f28aed150085612694ac8ed48a3cdb8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a6f28aed150085612694ac8ed48a3cdb8">swkbdSetFilterCallback</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, <a class="el" href="swkbd_8h.html#aa399c3ac23cdac010f1391caaeb3239c">SwkbdCallbackFn</a> callback, void *user)</td></tr>
|
|
<tr class="memdesc:a6f28aed150085612694ac8ed48a3cdb8"><td class="mdescLeft"> </td><td class="mdescRight">Configures a custom function to be used to check the validity of input when it is submitted in a software keyboard. <a href="swkbd_8h.html#a6f28aed150085612694ac8ed48a3cdb8">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f28aed150085612694ac8ed48a3cdb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a9e7271ab89d6727897b66cbb51a0a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a3a9e7271ab89d6727897b66cbb51a0a5">swkbdInputText</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd, char *buf, size_t bufsize)</td></tr>
|
|
<tr class="memdesc:a3a9e7271ab89d6727897b66cbb51a0a5"><td class="mdescLeft"> </td><td class="mdescRight">Launches a software keyboard in order to input text. <a href="swkbd_8h.html#a3a9e7271ab89d6727897b66cbb51a0a5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3a9e7271ab89d6727897b66cbb51a0a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fe63b706b3a5f4196e8a464db578d10"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93">SwkbdResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="swkbd_8h.html#a9fe63b706b3a5f4196e8a464db578d10">swkbdGetResult</a> (<a class="el" href="structSwkbdState.html">SwkbdState</a> *swkbd)</td></tr>
|
|
<tr class="memdesc:a9fe63b706b3a5f4196e8a464db578d10"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the result condition of a software keyboard after it has been used. <a href="swkbd_8h.html#a9fe63b706b3a5f4196e8a464db578d10">More...</a><br /></td></tr>
|
|
<tr class="separator:a9fe63b706b3a5f4196e8a464db578d10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Software keyboard applet. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a99fb83031ce9923c84392b4e92f956b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99fb83031ce9923c84392b4e92f956b5">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard input filtering flags. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5aa03c93ae6d25484d672a409bec1c79ef"></a>SWKBD_FILTER_DIGITS </td><td class="fielddoc"><p>Disallow the use of more than a certain number of digits (0 or more) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5a556df4c35b36612b092e414600e30eed"></a>SWKBD_FILTER_AT </td><td class="fielddoc"><p>Disallow the use of the @ sign. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5ab4a359ee3ad3a4394c186bd6ba676d37"></a>SWKBD_FILTER_PERCENT </td><td class="fielddoc"><p>Disallow the use of the % sign. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5a8385e631b1b3313c05a2f80097021af6"></a>SWKBD_FILTER_BACKSLASH </td><td class="fielddoc"><p>Disallow the use of the \ sign. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5a241d66f1b98f9de0da217356d5b2e4bf"></a>SWKBD_FILTER_PROFANITY </td><td class="fielddoc"><p>Disallow profanity using Nintendo's profanity filter. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a99fb83031ce9923c84392b4e92f956b5a791a253769fb274e58d0edc5b69f44c5"></a>SWKBD_FILTER_CALLBACK </td><td class="fielddoc"><p>Use a callback in order to check the input. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc6126af1d45847bc59afa0aa3216b04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc6126af1d45847bc59afa0aa3216b04">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard features. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04a70304b094e5acd73deb9bb8b27128e7a"></a>SWKBD_PARENTAL </td><td class="fielddoc"><p>Parental PIN mode. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04ab7aec191ef2d5df62291a011f5c0a4e7"></a>SWKBD_DARKEN_TOP_SCREEN </td><td class="fielddoc"><p>Darken the top screen when the keyboard is shown. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04adf8b88dbe0a36d524a5cde8e7af45bd4"></a>SWKBD_PREDICTIVE_INPUT </td><td class="fielddoc"><p>Enable predictive input (necessary for Kanji input in JPN systems). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04ab38ff5f2098240b8fc288a0df7b41ac5"></a>SWKBD_MULTILINE </td><td class="fielddoc"><p>Enable multiline input. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04aae3631524844bce7fb3aceb10416391f"></a>SWKBD_FIXED_WIDTH </td><td class="fielddoc"><p>Enable fixed-width mode. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04aac6fa4f37d2db0c7ee8a0b247ebc2cf1"></a>SWKBD_ALLOW_HOME </td><td class="fielddoc"><p>Allow the usage of the HOME button. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04a82d4882b4e8e601e82dbf301be793e0e"></a>SWKBD_ALLOW_RESET </td><td class="fielddoc"><p>Allow the usage of a software-reset combination. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04a22cc81cb2524dbcedf88ecd51d6174e4"></a>SWKBD_ALLOW_POWER </td><td class="fielddoc"><p>Allow the usage of the POWER button. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="abc6126af1d45847bc59afa0aa3216b04ac44a4dee33fa25059f283be8e241fc62"></a>SWKBD_DEFAULT_QWERTY </td><td class="fielddoc"><p>Default to the QWERTY page when the keyboard is shown. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94ea720afdaf86a4be385aa913c6a29c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94ea720afdaf86a4be385aa913c6a29c">◆ </a></span>SwkbdButton</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard dialog buttons. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a94ea720afdaf86a4be385aa913c6a29ca04b5951221df3ade6e04447b590d1fd4"></a>SWKBD_BUTTON_LEFT </td><td class="fielddoc"><p>Left button (usually Cancel) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a94ea720afdaf86a4be385aa913c6a29ca7fbeb491bb84654eabad38826a00edd5"></a>SWKBD_BUTTON_MIDDLE </td><td class="fielddoc"><p>Middle button (usually I Forgot) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a94ea720afdaf86a4be385aa913c6a29ca2754579a6b7bf2b751751b5a9ca8c4b3"></a>SWKBD_BUTTON_RIGHT </td><td class="fielddoc"><p>Right button (usually OK) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a94ea720afdaf86a4be385aa913c6a29caa7a4d5142a471089f281173d35f52675"></a>SWKBD_BUTTON_NONE </td><td class="fielddoc"><p>No button (returned by swkbdInputText in special cases) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12d91ff65b198511e8d26960577d2c7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12d91ff65b198511e8d26960577d2c7a">◆ </a></span>SwkbdCallbackResult</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#a12d91ff65b198511e8d26960577d2c7a">SwkbdCallbackResult</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard filter callback return values. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a12d91ff65b198511e8d26960577d2c7aaec9de9f165d0d788152aa5d3dfc21327"></a>SWKBD_CALLBACK_OK </td><td class="fielddoc"><p>Specifies that the input is valid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a12d91ff65b198511e8d26960577d2c7aa9238474d1113e68576271d5c1e87aa2c"></a>SWKBD_CALLBACK_CLOSE </td><td class="fielddoc"><p>Displays an error message, then closes the keyboard. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a12d91ff65b198511e8d26960577d2c7aaf65d5b95476c302b9201d1278761275b"></a>SWKBD_CALLBACK_CONTINUE </td><td class="fielddoc"><p>Displays an error message and continues displaying the keyboard. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7dddf239d1add2f4a68d79ca0e64c1b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dddf239d1add2f4a68d79ca0e64c1b9">◆ </a></span>SwkbdPasswordMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9">SwkbdPasswordMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard password modes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7dddf239d1add2f4a68d79ca0e64c1b9aa862068a3d6d1d30c9c2343025368d56"></a>SWKBD_PASSWORD_NONE </td><td class="fielddoc"><p>Characters are not concealed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dddf239d1add2f4a68d79ca0e64c1b9a1da6c004e85d5d11b798c5805ea2f3dc"></a>SWKBD_PASSWORD_HIDE </td><td class="fielddoc"><p>Characters are concealed immediately. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7dddf239d1add2f4a68d79ca0e64c1b9aa2ec3ada05cfa6de081da8288635d110"></a>SWKBD_PASSWORD_HIDE_DELAY </td><td class="fielddoc"><p>Characters are concealed a second after they've been typed. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa02a4a80747eb05ddb85235a0a41ee93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa02a4a80747eb05ddb85235a0a41ee93">◆ </a></span>SwkbdResult</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93">SwkbdResult</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard return values. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a59071ee22605a66a8ca2700a9c1ae77d"></a>SWKBD_NONE </td><td class="fielddoc"><p>Dummy/unused. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93abd740c8d864f5c00d81c1cf31144eaef"></a>SWKBD_INVALID_INPUT </td><td class="fielddoc"><p>Invalid parameters to swkbd. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93aaac828716362cc53057fbcaf731b2c25"></a>SWKBD_OUTOFMEM </td><td class="fielddoc"><p>Out of memory. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a76d54e4492757452c7c20aad596bc037"></a>SWKBD_D0_CLICK </td><td class="fielddoc"><p>The button was clicked in 1-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93aecf7620ac2b17d05dd2583785e4fe67d"></a>SWKBD_D1_CLICK0 </td><td class="fielddoc"><p>The left button was clicked in 2-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93ac39a32d53c9e3f20017492d0b521a936"></a>SWKBD_D1_CLICK1 </td><td class="fielddoc"><p>The right button was clicked in 2-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a0225d1a05505f3439832d3a5b6c12095"></a>SWKBD_D2_CLICK0 </td><td class="fielddoc"><p>The left button was clicked in 3-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a9761ef300b084cda9feff81657bb3783"></a>SWKBD_D2_CLICK1 </td><td class="fielddoc"><p>The middle button was clicked in 3-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a199451004dc9755c37f34cba29089817"></a>SWKBD_D2_CLICK2 </td><td class="fielddoc"><p>The right button was clicked in 3-button dialogs. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93aac0b81dd3cf9855a464ae1429d4dde44"></a>SWKBD_HOMEPRESSED </td><td class="fielddoc"><p>The HOME button was pressed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a76e7d6d7ebf659dd635fb8ca4cfa919b"></a>SWKBD_RESETPRESSED </td><td class="fielddoc"><p>The soft-reset key combination was pressed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93aa4458c14c72bfd33d3bd1c1c832bef00"></a>SWKBD_POWERPRESSED </td><td class="fielddoc"><p>The POWER button was pressed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a1ed59bc024b62a5b6c075dfc8a0534d6"></a>SWKBD_PARENTAL_OK </td><td class="fielddoc"><p>The parental PIN was verified successfully. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93af5061a0c471654f4dd68cc59519f7188"></a>SWKBD_PARENTAL_FAIL </td><td class="fielddoc"><p>The parental PIN was incorrect. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa02a4a80747eb05ddb85235a0a41ee93a2b71a09c9b94f64e6f51cb927646c8eb"></a>SWKBD_BANNED_INPUT </td><td class="fielddoc"><p>The filter callback returned SWKBD_CALLBACK_CLOSE. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad88d214560b9bbaf1391cc7013ab4387"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad88d214560b9bbaf1391cc7013ab4387">◆ </a></span>SwkbdType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387">SwkbdType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Keyboard types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad88d214560b9bbaf1391cc7013ab4387a09e29e270f59d0b17f06c8455d6a836c"></a>SWKBD_TYPE_NORMAL </td><td class="fielddoc"><p>Normal keyboard with several pages (QWERTY/accents/symbol/mobile) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ad88d214560b9bbaf1391cc7013ab4387afb5f26b787995fc4b88a1668e4a99c09"></a>SWKBD_TYPE_QWERTY </td><td class="fielddoc"><p>QWERTY keyboard only. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ad88d214560b9bbaf1391cc7013ab4387a5802f3a1eabee6305045ed5cd57ae5b9"></a>SWKBD_TYPE_NUMPAD </td><td class="fielddoc"><p>Number pad. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ad88d214560b9bbaf1391cc7013ab4387a0f871d4bbdd45581d73f4877fafdb002"></a>SWKBD_TYPE_WESTERN </td><td class="fielddoc"><p>On JPN systems, a text keyboard without Japanese input capabilities, otherwise same as SWKBD_TYPE_NORMAL. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c2863f4e484d07ba6be8fdf84bb96a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c2863f4e484d07ba6be8fdf84bb96a1">◆ </a></span>SwkbdValidInput</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1">SwkbdValidInput</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Accepted input types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9c2863f4e484d07ba6be8fdf84bb96a1adf5ca7a645dea83448551248be05bc35"></a>SWKBD_ANYTHING </td><td class="fielddoc"><p>All inputs are accepted. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9c2863f4e484d07ba6be8fdf84bb96a1a9d1709266de5138ac0a0fb415b62935e"></a>SWKBD_NOTEMPTY </td><td class="fielddoc"><p>Empty inputs are not accepted. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9c2863f4e484d07ba6be8fdf84bb96a1a1caa32cefb6ab95f86a42b4dbd137feb"></a>SWKBD_NOTEMPTY_NOTBLANK </td><td class="fielddoc"><p>Empty or blank inputs (consisting solely of whitespace) are not accepted. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9c2863f4e484d07ba6be8fdf84bb96a1a1025cd177247c0b2482c0bbac789f798"></a>SWKBD_NOTBLANK </td><td class="fielddoc"><p>Blank inputs (consisting solely of whitespace) are not accepted, but empty inputs are. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9c2863f4e484d07ba6be8fdf84bb96a1a39be8bd578ff7ffad04190228e60a1a9"></a>SWKBD_FIXEDLEN </td><td class="fielddoc"><p>The input must have a fixed length (specified by maxTextLength in swkbdInit). </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a9fe63b706b3a5f4196e8a464db578d10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fe63b706b3a5f4196e8a464db578d10">◆ </a></span>swkbdGetResult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="swkbd_8h.html#aa02a4a80747eb05ddb85235a0a41ee93">SwkbdResult</a> swkbdGetResult </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the result condition of a software keyboard after it has been used. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The result value. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a54">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac3a6569aa3150430e729b328999561ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3a6569aa3150430e729b328999561ed">◆ </a></span>swkbdInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="swkbd_8h.html#ad88d214560b9bbaf1391cc7013ab4387">SwkbdType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>numButtons</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>maxTextLength</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes software keyboard status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">type</td><td>Keyboard type. </td></tr>
|
|
<tr><td class="paramname">numButtons</td><td>Number of dialog buttons to display (1, 2 or 3). </td></tr>
|
|
<tr><td class="paramname">maxTextLength</td><td>Maximum number of UTF-16 code units that input text can have (or -1 to let libctru use a big default). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a15">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a9e7271ab89d6727897b66cbb51a0a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a9e7271ab89d6727897b66cbb51a0a5">◆ </a></span>swkbdInputText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a> swkbdInputText </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>bufsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launches a software keyboard in order to input text. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">buf</td><td>Pointer to output buffer which will hold the inputted text. </td></tr>
|
|
<tr><td class="paramname">bufsize</td><td>Maximum number of UTF-8 code units that the buffer can hold (including null terminator). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The identifier of the dialog button that was pressed, or SWKBD_BUTTON_NONE if a different condition was triggered - in that case use swkbdGetResult to check the condition. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a30">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03c1c95303c37468bda0077e8d986e00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03c1c95303c37468bda0077e8d986e00">◆ </a></span>swkbdSetButton()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="swkbd_8h.html#a94ea720afdaf86a4be385aa913c6a29c">SwkbdButton</a> </td>
|
|
<td class="paramname"><em>button</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>submit</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures a dialog button in a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">button</td><td>Specifies which button to configure. </td></tr>
|
|
<tr><td class="paramname">text</td><td>Button text. </td></tr>
|
|
<tr><td class="paramname">submit</td><td>Specifies whether pushing the button will submit the text or discard it. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a19">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8c2bcf30bd16119cab4a58c15d85495"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8c2bcf30bd16119cab4a58c15d85495">◆ </a></span>swkbdSetDictionary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetDictionary </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structSwkbdDictWord.html">SwkbdDictWord</a> * </td>
|
|
<td class="paramname"><em>dict</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>wordCount</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the custom word dictionary to be used with the predictive input system of a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">dict</td><td>Pointer to dictionary words. </td></tr>
|
|
<tr><td class="paramname">wordCount</td><td>Number of words in the dictionary. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a27">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7abf5422dcf03764ffba1eaaca8c1653"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7abf5422dcf03764ffba1eaaca8c1653">◆ </a></span>swkbdSetDictWord()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetDictWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdDictWord.html">SwkbdDictWord</a> * </td>
|
|
<td class="paramname"><em>word</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>reading</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>text</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures a word in a predictive dictionary for use with a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">word</td><td>Pointer to dictionary word structure. </td></tr>
|
|
<tr><td class="paramname">reading</td><td>Reading of the word, that is, the sequence of characters that need to be typed to trigger the word in the predictive input system. </td></tr>
|
|
<tr><td class="paramname">text</td><td>Spelling of the word, that is, the actual characters that will be produced when the user decides to select the word. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a26">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ab5f470b1bde4cc7d8ea7336c078098"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ab5f470b1bde4cc7d8ea7336c078098">◆ </a></span>swkbdSetFeatures()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetFeatures </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>features</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Specifies which special features are enabled in a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">features</td><td>Feature bitmask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a23">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f28aed150085612694ac8ed48a3cdb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f28aed150085612694ac8ed48a3cdb8">◆ </a></span>swkbdSetFilterCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetFilterCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="swkbd_8h.html#aa399c3ac23cdac010f1391caaeb3239c">SwkbdCallbackFn</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>user</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures a custom function to be used to check the validity of input when it is submitted in a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>Filter callback function. </td></tr>
|
|
<tr><td class="paramname">user</td><td>Custom data to be passed to the callback function. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a53">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab50d59110e5920e1aba641b607900277"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab50d59110e5920e1aba641b607900277">◆ </a></span>swkbdSetHintText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetHintText </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>text</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the hint text of a software keyboard (that is, the help text that is displayed when the textbox is empty). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">text</td><td>Hint text. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a18">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3188c3c8f62da1f740e195976dcabf1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3188c3c8f62da1f740e195976dcabf1f">◆ </a></span>swkbdSetInitialText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetInitialText </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>text</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the initial text that a software keyboard will display on launch. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">text</td><td>Initial text. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a17">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a790328be559c7d75558faa7a5b055d2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a790328be559c7d75558faa7a5b055d2c">◆ </a></span>swkbdSetLearningData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetLearningData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdLearningData.html">SwkbdLearningData</a> * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures software keyboard predictive input learning data management. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">data</td><td>Pointer to learning data structure (can be in, out or both depending on the other parameters). </td></tr>
|
|
<tr><td class="paramname">in</td><td>Specifies whether the data should be read from the structure when the keyboard is launched. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Specifies whether the data should be written to the structure when the keyboard is closed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a29">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad00d7ebd131e5171fca3beddace66890"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad00d7ebd131e5171fca3beddace66890">◆ </a></span>swkbdSetNumpadKeys()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void swkbdSetNumpadKeys </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>left</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>right</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures what characters will the two bottom keys in a numpad produce. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">left</td><td>Unicode codepoint produced by the leftmost key in the bottom row (0 hides the key). </td></tr>
|
|
<tr><td class="paramname">left</td><td>Unicode codepoint produced by the rightmost key in the bottom row (0 hides the key). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a38">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94b68f3e03958c2a609458641be484a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94b68f3e03958c2a609458641be484a2">◆ </a></span>swkbdSetPasswordMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void swkbdSetPasswordMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="swkbd_8h.html#a7dddf239d1add2f4a68d79ca0e64c1b9">SwkbdPasswordMode</a> </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures password mode in a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>Password mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a33">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97006a5ab548ac7dc1db471286b157ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97006a5ab548ac7dc1db471286b157ba">◆ </a></span>swkbdSetStatusData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void swkbdSetStatusData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdStatusData.html">SwkbdStatusData</a> * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures software keyboard internal status management. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">data</td><td>Pointer to internal status structure (can be in, out or both depending on the other parameters). </td></tr>
|
|
<tr><td class="paramname">in</td><td>Specifies whether the data should be read from the structure when the keyboard is launched. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Specifies whether the data should be written to the structure when the keyboard is closed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a28">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a98b664f7bc103e24ef0402e16bfc3dbf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a98b664f7bc103e24ef0402e16bfc3dbf">◆ </a></span>swkbdSetValidation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void swkbdSetValidation </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structSwkbdState.html">SwkbdState</a> * </td>
|
|
<td class="paramname"><em>swkbd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="swkbd_8h.html#a9c2863f4e484d07ba6be8fdf84bb96a1">SwkbdValidInput</a> </td>
|
|
<td class="paramname"><em>validInput</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>filterFlags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>maxDigits</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures input validation in a software keyboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">swkbd</td><td>Pointer to swkbd state. </td></tr>
|
|
<tr><td class="paramname">validInput</td><td>Specifies which inputs are valid. </td></tr>
|
|
<tr><td class="paramname">filterFlags</td><td>Bitmask specifying which characters are disallowed (filtered). </td></tr>
|
|
<tr><td class="paramname">maxDigits</td><td>In case digits are disallowed, specifies how many digits are allowed at maximum in input strings (0 completely restricts digit input). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a35">input/software-keyboard/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|