273 lines
14 KiB
HTML
273 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ewol Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ewol library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ewol/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a href="namespace_ewol.html">ewol</a>
|
|
<ul class="niveau2">
|
|
<li><a href="namespace_ewol__translate.html">translate</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__key.html">key</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__widget.html">widget</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__openGL.html">openGL</a>
|
|
</li>
|
|
<li class="sousmenu"><a href="namespace_ewol__context.html">context</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__context__clipBoard.html">clipBoard</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_ewol__compositing.html">compositing</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__object.html">object</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__resource.html">resource</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__font.html">font</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__event.html">event</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_MacOs.html">MacOs</a>
|
|
</li>
|
|
<li><a href="namespace_IOs.html">IOs</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h3>Documentation:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="001_bases.html">Bases</a></li>
|
|
</ul><ul class="niveau1"><li><a href="faq.html">Faq</a></li>
|
|
</ul></div>
|
|
<h3>Tutorials:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_001_HelloWord.html">Hello word</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_010_ObjectModel.html">Object model</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_011_ObjectConfig.html">Object config</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_012_ObjectMessage.html">Object message</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_020_FileAccess.html">File access</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_021_Resources.html">Resources</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_030_ConplexeXmlGui.html">Conplexe xml gui</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_050_CreateCustomWidget.html">Create custom widget</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_051_AddWidgetCustumInXML.html">Add widget custum in x m l</a></li>
|
|
</ul></div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: ewol::key::Special</h1><hr/><h2>Description:</h2>
|
|
This class consider generic special keyborad key (insert, control, shift ...)<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#148">Special</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <span class="code-type" >bool</span> <a class="code-function" href="#149">getCapsLock</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#150">setCapsLock</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#152">getShift</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#153">setShift</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#155">getCtrl</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#156">setCtrl</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#158">getMeta</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#159">setMeta</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#161">getAlt</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#162">setAlt</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#164">getAltGr</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#165">setAltGr</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#167">getNumLock</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#168">setNumLock</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#170">getInsert</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#171">setInsert</a> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#173">update</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__keyboard.html">ewol::key::keyboard</a> <span class="code-argument">_move</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>);<br/></pre>
|
|
<br/>
|
|
<h2>Detail:</h2>
|
|
<a id="148"/><a id="149"/><h3>Special</h3><pre>
|
|
+ <span class="code-function">Special</span> ();<br/></pre>
|
|
Main constructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="150"/><h3>getCapsLock</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getCapsLock</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
get the current CapLock Status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The CapLock value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="152"/><h3>setCapsLock</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setCapsLock</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
set the current CapLock Status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new CapLock value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="153"/><h3>getShift</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getShift</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Shift key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Shift value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="155"/><h3>setShift</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setShift</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Shift key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Shift value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="156"/><h3>getCtrl</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getCtrl</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the Current Control key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Control value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="158"/><h3>setCtrl</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setCtrl</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the Current Control key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Control value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="159"/><h3>getMeta</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getMeta</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Meta key status (also named windows or apple key)<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Meta value (name Windows key, apple key, command key ...)</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="161"/><h3>setMeta</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setMeta</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Meta key status (also named windows or apple key)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Meta value (name Windows key, apple key, command key ...)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="162"/><h3>getAlt</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getAlt</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Alt key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Alt value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="164"/><h3>setAlt</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setAlt</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Alt key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Alt value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="165"/><h3>getAltGr</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getAltGr</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Alt-Gr key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Alt-gr value (does not exist on MacOs)</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="167"/><h3>setAltGr</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setAltGr</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Alt-Gr key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Alt-gr value (does not exist on MacOs)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="168"/><h3>getNumLock</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getNumLock</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Ver-num key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Numerical Lock value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="170"/><h3>setNumLock</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setNumLock</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Ver-num key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Numerical Lock value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="171"/><h3>getInsert</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">getInsert</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Get the current Intert key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The Insert value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="173"/><h3>setInsert</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setInsert</span> (<span class="code-type" >bool</span> <span class="code-argument">_value</span>);<br/></pre>
|
|
Set the current Intert key status<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> The new Insert value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>update</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">update</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__keyboard.html">ewol::key::keyboard</a> <span class="code-argument">_move</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>);<br/></pre>
|
|
Update the internal value with the input moving key.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_move</span> </td><td> Moving key.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_isFown</span> </td><td> The Key is pressed or not.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|