atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/doc/ewol__eInput.html

313 lines
20 KiB
HTML
Raw Blame History

<!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">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1>ewol Library</h1>
<li><a href="eSystemMessage.html">eSystemMessage</a></li>
<li>ewol</li>
<ul>
<li><a href="ewol__Area.html">Area</a></li>
<li><a href="ewol__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__Dimension.html">Dimension</a></li>
<li><a href="ewol__DrawProperty.html">DrawProperty</a></li>
<li><a href="ewol__Drawing.html">Drawing</a></li>
<li><a href="ewol__EConfig.html">EConfig</a></li>
<li><a href="ewol__EConfigElement.html">EConfigElement</a></li>
<li><a href="ewol__EMessage.html">EMessage</a></li>
<li><a href="ewol__EMultiCast.html">EMultiCast</a></li>
<li><a href="ewol__EMultiCast__MessageList.html">EMultiCast::MessageList</a></li>
<li><a href="ewol__EObject.html">EObject</a></li>
<li><a href="ewol__EObjectManager.html">EObjectManager</a></li>
<li><a href="ewol__EventEntry.html">EventEntry</a></li>
<li><a href="ewol__EventEntrySystem.html">EventEntrySystem</a></li>
<li><a href="ewol__EventExtGen.html">EventExtGen</a></li>
<li><a href="ewol__EventInput.html">EventInput</a></li>
<li><a href="ewol__EventInputSystem.html">EventInputSystem</a></li>
<li><a href="ewol__EventShortCut.html">EventShortCut</a></li>
<li><a href="ewol__EventTime.html">EventTime</a></li>
<li><a href="ewol__Face.html">Face</a></li>
<li><a href="ewol__FaceIndexing.html">FaceIndexing</a></li>
<li><a href="ewol__FontBase.html">FontBase</a></li>
<li><a href="ewol__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__Fps.html">Fps</a></li>
<li><a href="ewol__GlyphProperty.html">GlyphProperty</a></li>
<li><a href="ewol__Image.html">Image</a></li>
<li><a href="ewol__Kerning.html">Kerning</a></li>
<li><a href="ewol__Light.html">Light</a></li>
<li><a href="ewol__Material.html">Material</a></li>
<li><a href="ewol__MaterialGlId.html">MaterialGlId</a></li>
<li><a href="ewol__Mesh.html">Mesh</a></li>
<li><a href="ewol__PhysicsBox.html">PhysicsBox</a></li>
<li><a href="ewol__PhysicsCapsule.html">PhysicsCapsule</a></li>
<li><a href="ewol__PhysicsCone.html">PhysicsCone</a></li>
<li><a href="ewol__PhysicsConvexHull.html">PhysicsConvexHull</a></li>
<li><a href="ewol__PhysicsCylinder.html">PhysicsCylinder</a></li>
<li><a href="ewol__PhysicsShape.html">PhysicsShape</a></li>
<li><a href="ewol__PhysicsSphere.html">PhysicsSphere</a></li>
<li><a href="ewol__Program.html">Program</a></li>
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__ResourceManager.html">ResourceManager</a></li>
<li><a href="ewol__Shader.html">Shader</a></li>
<li><a href="ewol__Shaper.html">Shaper</a></li>
<li><a href="ewol__SimpleConfigElement.html">SimpleConfigElement</a></li>
<li><a href="ewol__SpecialKey.html">SpecialKey</a></li>
<li><a href="ewol__SpecialKey__SpecialKey__union__.html">SpecialKey::SpecialKey::union ::</a></li>
<li><a href="ewol__SpecialKey__union.html">SpecialKey::union </a></li>
<li><a href="ewol__Sprite.html">Sprite</a></li>
<li><a href="ewol__Text.html">Text</a></li>
<li><a href="ewol__TextDecoration.html">TextDecoration</a></li>
<li><a href="ewol__Texture.html">Texture</a></li>
<li><a href="ewol__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__VirtualBufferObject.html">VirtualBufferObject</a></li>
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__WidgetManager.html">WidgetManager</a></li>
<li><a href="ewol__Windows.html">Windows</a></li>
<li><a href="ewol__eContext.html">eContext</a></li>
<li><a href="ewol__eInput.html">eInput</a></li>
<li><a href="ewol__progAttributeElement.html">progAttributeElement</a></li>
</ul>
<li>widget</li>
<ul>
<li><a href="widget__Button.html">Button</a></li>
<li><a href="widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="widget__CheckBox.html">CheckBox</a></li>
<li><a href="widget__ColorBar.html">ColorBar</a></li>
<li><a href="widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="widget__Composer.html">Composer</a></li>
<li><a href="widget__Container.html">Container</a></li>
<li><a href="widget__ContainerN.html">ContainerN</a></li>
<li><a href="widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="widget__Entry.html">Entry</a></li>
<li><a href="widget__FileChooser.html">FileChooser</a></li>
<li><a href="widget__Gird.html">Gird</a></li>
<li><a href="widget__Gird__GirdProperties.html">Gird::GirdProperties</a></li>
<li><a href="widget__Image.html">Image</a></li>
<li><a href="widget__Joystick.html">Joystick</a></li>
<li><a href="widget__Label.html">Label</a></li>
<li><a href="widget__Layer.html">Layer</a></li>
<li><a href="widget__List.html">List</a></li>
<li><a href="widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="widget__Menu.html">Menu</a></li>
<li><a href="widget__MenuElement.html">MenuElement</a></li>
<li><a href="widget__Mesh.html">Mesh</a></li>
<li><a href="widget__Parameter.html">Parameter</a></li>
<li><a href="widget__ParameterList.html">ParameterList</a></li>
<li><a href="widget__PopUp.html">PopUp</a></li>
<li><a href="widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="widget__Scroll.html">Scroll</a></li>
<li><a href="widget__Sizer.html">Sizer</a></li>
<li><a href="widget__Slider.html">Slider</a></li>
<li><a href="widget__Spacer.html">Spacer</a></li>
<li><a href="widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="widget__WSlider.html">WSlider</a></li>
<li><a href="widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="widget__elementPL.html">elementPL</a></li>
</ul>
</ul>
<li>ewol</li>
<ul>
<li><a href="ewol__clipBoard__clipboardListe.html">clipBoard::clipboardListe</a></li>
<li><a href="ewol__cursorDisplay.html">cursorDisplay</a></li>
<li><a href="ewol__font__mode.html">font::mode</a></li>
<li><a href="ewol__gravity.html">gravity</a></li>
<li><a href="ewol__keyEvent__keyboard.html">keyEvent::keyboard</a></li>
<li><a href="ewol__keyEvent__status.html">keyEvent::status</a></li>
<li><a href="ewol__keyEvent__type.html">keyEvent::type</a></li>
<li><a href="ewol__openGL__openGlFlags.html">openGL::openGlFlags</a></li>
<li><a href="ewol__orientation.html">orientation</a></li>
</ul>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::eInput</h1>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-function" href="#eInput">eInput</a> (<a href="ewol__eContext.html" class="code-type">ewol::eContext</a> & <span class="code-argument">_context</span>);<br>+ ~<a class="code-function" href="#eInput">eInput</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setDpi">setDpi</a> (<span class="code-type">int32_t</span> <span class="code-argument">newDPI</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#motion">motion</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,<br/> <span class="code-type">int</span> <span class="code-argument">_pointerID</span>,<br/> vec2 <span class="code-argument">_pos</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#state">state</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,<br/> <span class="code-type">int</span> <span class="code-argument">_pointerID</span>,<br/> <span class="code-type">bool</span> <span class="code-argument">_isDown</span>,<br/> vec2 <span class="code-argument">_pos</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onObjectRemove">onObjectRemove</a> (<a href="ewol__EObject.html" class="code-type">ewol::EObject</a> * <span class="code-argument">_removeObject</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#newLayerSet">newLayerSet</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#transfertEvent">transfertEvent</a> (<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_source</span>,<br/> <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destination</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#grabPointer">grabPointer</a> (<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_widget</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#unGrabPointer">unGrabPointer</a> (<span class="code-type">void</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#calculateLimit">calculateLimit</a> (<span class="code-type">void</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#abortElement">abortElement</a> (InputPoperty_ts * <span class="code-argument">_eventTable</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">_idInput</span>,<br/> <span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#cleanElement">cleanElement</a> (InputPoperty_ts * <span class="code-argument">_eventTable</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">_idInput</span>);<br>- <span class="code-type">bool</span> <a class="code-function" href="#localEventInput">localEventInput</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,<br/> <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destWidget</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">_IdInput</span>,<br/> <span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__status.html" class="code-type">ewol::keyEvent::status</a> <span class="code-argument">_typeEvent</span>,<br/> vec2 <span class="code-argument">_pos</span>);<br>- <span class="code-type">int32_t</span> <a class="code-function" href="#localGetDestinationId">localGetDestinationId</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,<br/> <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destWidget</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">_realInputId</span>);<br></pre>
<h2>Detail:<h2>
<h3>ewol::<a id="eInput">eInput</a> ()</h3>
<pre>
<span class="code-function">eInput</span>(<a href="ewol__eContext.html" class="code-type">ewol::eContext</a> & <span class="code-argument">_context</span>);</pre>
<br/>
<br/>
<hr/>
<h3>ewol::~<a id="eInput">eInput</a> ()</h3>
<pre>
~<span class="code-function">eInput</span>(<span class="code-type">void</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="setDpi">setDpi</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setDpi</span>(<span class="code-type">int32_t</span> <span class="code-argument">newDPI</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="motion">motion</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">motion</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,
<span class="code-type">int</span> <span class="code-argument">_pointerID</span>,
vec2 <span class="code-argument">_pos</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="state">state</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">state</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,
<span class="code-type">int</span> <span class="code-argument">_pointerID</span>,
<span class="code-type">bool</span> <span class="code-argument">_isDown</span>,
vec2 <span class="code-argument">_pos</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="onObjectRemove">onObjectRemove</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">onObjectRemove</span>(<a href="ewol__EObject.html" class="code-type">ewol::EObject</a> * <span class="code-argument">_removeObject</span>);</pre>
<br/>
Inform object that an other object is removed ...
<br/><b>Notes:</b> : Sub classes must call this class
<br/> <ul>
<b>Parameter [input]:</b> <span class="code-argument">removeObject</span> Pointer on the EObject remeved == > the user must remove all reference on this EObject
<br/></ul>
<br/>
<hr/>
<h3><a id="newLayerSet">newLayerSet</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">newLayerSet</span>(<span class="code-type">void</span>);</pre>
<br/>
a new layer on the windows is set == > might remove all the property of the current element ...
<br/><br/>
<hr/>
<h3><a id="transfertEvent">transfertEvent</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">transfertEvent</span>(<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_source</span>,
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destination</span>);</pre>
<br/>
This is to transfert the event from one widget to another one
<br/><ul>
<b>Parameter:</b> <span class="code-argument">_source</span> the widget where the event came from
<br/><b>Parameter:</b> <span class="code-argument">_destination</span> the widget where the event mitgh be generated now
<br/></ul>
<br/>
<hr/>
<h3><a id="grabPointer">grabPointer</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">grabPointer</span>(<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_widget</span>);</pre>
<br/>
This fonction lock the pointer properties to move in relative instead of absolute
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_widget</span> The widget that lock the pointer events
<br/></ul>
<br/>
<hr/>
<h3><a id="unGrabPointer">unGrabPointer</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">unGrabPointer</span>(<span class="code-type">void</span>);</pre>
<br/>
This fonction un-lock the pointer properties to move in relative instead of absolute
<br/><br/>
<hr/>
<h3><a id="calculateLimit">calculateLimit</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">calculateLimit</span>(<span class="code-type">void</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="abortElement">abortElement</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">abortElement</span>(InputPoperty_ts * <span class="code-argument">_eventTable</span>,
<span class="code-type">int32_t</span> <span class="code-argument">_idInput</span>,
<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="cleanElement">cleanElement</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">cleanElement</span>(InputPoperty_ts * <span class="code-argument">_eventTable</span>,
<span class="code-type">int32_t</span> <span class="code-argument">_idInput</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="localEventInput">localEventInput</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">localEventInput</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destWidget</span>,
<span class="code-type">int32_t</span> <span class="code-argument">_IdInput</span>,
<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__status.html" class="code-type">ewol::keyEvent::status</a> <span class="code-argument">_typeEvent</span>,
vec2 <span class="code-argument">_pos</span>);</pre>
<br/>
generate the event on the destinated widget.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_type</span> Type of the event that might be sended.
<br/><b>Parameter [input]:</b> <span class="code-argument">_destWidget</span> Pointer on the requested widget that element might be sended
<br/><b>Parameter [input]:</b> <span class="code-argument">_IdInput</span> Id of the event (PC : [0..9] and touch : [1..9])
<br/><b>Parameter [input]:</b> <span class="code-argument">_typeEvent</span> type of the eventg generated
<br/><b>Parameter [input]:</b> <span class="code-argument">_pos</span> position of the event
<br/><b>Return:</b> true if event has been greped
<br/></ul>
<br/>
<hr/>
<h3><a id="localGetDestinationId">localGetDestinationId</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">localGetDestinationId</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__type.html" class="code-type">ewol::keyEvent::type</a> <span class="code-argument">_type</span>,
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_destWidget</span>,
<span class="code-type">int32_t</span> <span class="code-argument">_realInputId</span>);</pre>
<br/>
convert the system event id in the correct EWOL id depending of the system management mode
This function find the next input id unused on the specifiic widget
== > on PC, the ID does not change (GUI is not the same)
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_type</span> Type of the kay event.
<br/><b>Parameter [input]:</b> <span class="code-argument">_destWidget</span> Pointer of the widget destination
<br/><b>Parameter [input]:</b> <span class="code-argument">_realInputId</span> system Id
<br/><b>Return:</b> the ewol input id
<br/></ul>
<br/>
<hr/>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink