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

325 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">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1>ewol Library</h1>
<div id="menu">
<h2>ewol</h2>
<ul class="niveau1">
<li class="sousmenu"><a>compositing</a>
<ul class="niveau2">
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__compositing__Area.html">Area</a></li>
<li><a href="ewol__compositing__Drawing.html">Drawing</a></li>
<li><a href="ewol__compositing__Image.html">Image</a></li>
<li><a href="ewol__compositing__Shaper.html">Shaper</a></li>
<li><a href="ewol__compositing__Sprite.html">Sprite</a></li>
<li><a href="ewol__compositing__Text.html">Text</a></li>
</ul>
</li>
<li class="sousmenu"><a>context</a>
<ul class="niveau2">
<li><a href="ewol__Context.html">Context</a></li>
<li><a href="ewol__context__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__context__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__context__InputManager.html">InputManager</a></li>
<li class="sousmenu"><a href="ewol__context__clipBoard.html">clipBoard</a>
<ul class="niveau3">
<li><a href="ewol__context__clipBoard.html::clipboardListe">clipboardListe</a></li>
</ul>
</li>
<li><a href="ewol__context__cursorDisplay.html">cursorDisplay</a></li>
</ul>
</li>
<li class="sousmenu"><a>event</a>
<ul class="niveau2">
<li><a href="ewol__event__Entry.html">Entry</a></li>
<li><a href="ewol__event__EntrySystem.html">EntrySystem</a></li>
<li><a href="ewol__event__Input.html">Input</a></li>
<li><a href="ewol__event__InputSystem.html">InputSystem</a></li>
<li><a href="ewol__event__Time.html">Time</a></li>
</ul>
</li>
<li class="sousmenu"><a>key</a>
<ul class="niveau2">
<li><a href="ewol__key__Special.html">Special</a></li>
<li><a href="ewol__key__keyboard.html">keyboard</a></li>
<li><a href="ewol__key__status.html">status</a></li>
<li><a href="ewol__key__type.html">type</a></li>
</ul>
</li>
<li class="sousmenu"><a>object</a>
<ul class="niveau2">
<li><a href="ewol__Object.html">Object</a></li>
<li><a href="ewol__object__Config.html">Config</a></li>
<li><a href="ewol__object__ConfigElement.html">ConfigElement</a></li>
<li><a href="ewol__object__Manager.html">Manager</a></li>
<li><a href="ewol__object__Message.html">Message</a></li>
<li class="sousmenu"><a href="ewol__object__MultiCast.html">MultiCast</a>
<ul class="niveau3">
<li><a href="ewol__object__MultiCast.html::MessageList">MessageList</a></li>
</ul>
</li>
</ul>
</li>
<li class="sousmenu"><a>openGL</a>
<ul class="niveau2">
<li><a href="ewol__openGL__openGlFlags.html">openGlFlags</a></li>
</ul>
</li>
<li class="sousmenu"><a>resource</a>
<ul class="niveau2">
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__resource__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__resource__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__resource__FontBase.html">FontBase</a></li>
<li><a href="ewol__resource__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__resource__Manager.html">Manager</a></li>
<li><a href="ewol__resource__Program.html">Program</a></li>
<li><a href="ewol__resource__Shader.html">Shader</a></li>
<li><a href="ewol__resource__Texture.html">Texture</a></li>
<li><a href="ewol__resource__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__resource__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__resource__VirtualBufferObject.html">VirtualBufferObject</a></li>
</ul>
</li>
<li class="sousmenu"><a>widget</a>
<ul class="niveau2">
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__widget__Button.html">Button</a></li>
<li><a href="ewol__widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="ewol__widget__CheckBox.html">CheckBox</a></li>
<li><a href="ewol__widget__ColorBar.html">ColorBar</a></li>
<li><a href="ewol__widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="ewol__widget__Composer.html">Composer</a></li>
<li><a href="ewol__widget__Container.html">Container</a></li>
<li><a href="ewol__widget__ContainerN.html">ContainerN</a></li>
<li><a href="ewol__widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="ewol__widget__Entry.html">Entry</a></li>
<li><a href="ewol__widget__FileChooser.html">FileChooser</a></li>
<li class="sousmenu"><a href="ewol__widget__Gird.html">Gird</a>
<ul class="niveau3">
<li><a href="ewol__widget__Gird.html::GirdProperties">GirdProperties</a></li>
</ul>
</li>
<li><a href="ewol__widget__Image.html">Image</a></li>
<li><a href="ewol__widget__Joystick.html">Joystick</a></li>
<li><a href="ewol__widget__Label.html">Label</a></li>
<li><a href="ewol__widget__Layer.html">Layer</a></li>
<li><a href="ewol__widget__List.html">List</a></li>
<li><a href="ewol__widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="ewol__widget__Manager.html">Manager</a></li>
<li><a href="ewol__widget__Menu.html">Menu</a></li>
<li><a href="ewol__widget__MenuElement.html">MenuElement</a></li>
<li><a href="ewol__widget__Parameter.html">Parameter</a></li>
<li><a href="ewol__widget__ParameterList.html">ParameterList</a></li>
<li><a href="ewol__widget__PopUp.html">PopUp</a></li>
<li><a href="ewol__widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="ewol__widget__Scroll.html">Scroll</a></li>
<li><a href="ewol__widget__Sizer.html">Sizer</a></li>
<li><a href="ewol__widget__Slider.html">Slider</a></li>
<li><a href="ewol__widget__Spacer.html">Spacer</a></li>
<li><a href="ewol__widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="ewol__widget__WSlider.html">WSlider</a></li>
<li><a href="ewol__widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="ewol__widget__Windows.html">Windows</a></li>
<li><a href="ewol__widget__elementPL.html">elementPL</a></li>
</ul>
</li>
<ul>
<h3> </h3>
</div>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::context::InputManager</h1>
<br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#InputManager">InputManager</a> (<a href="ewol__Context.html" class="code-type">ewol::Context</a> & <span class="code-argument">_context</span>);<br>+ ~<a class="code-function" href="#InputManager">InputManager</a> (<span class="code-type">void</span>);<br></pre>
<h2>Synopsis:</h2>
<pre>
+ <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__key__type.html" class="code-type">ewol::key::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__key__type.html" class="code-type">ewol::key::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__Object.html" class="code-type">ewol::Object</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 * <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__key__type.html" class="code-type">ewol::key::type</a> <span class="code-argument">_type</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#cleanElement">cleanElement</a> (InputPoperty * <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__key__type.html" class="code-type">ewol::key::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__key__status.html" class="code-type">ewol::key::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__key__type.html" class="code-type">ewol::key::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::context::<a id="InputManager">InputManager</a> ()</h3>
<pre>
<span class="code-function">InputManager</span>(<a href="ewol__Context.html" class="code-type">ewol::Context</a> & <span class="code-argument">_context</span>);</pre>
<br/>
<br/>
<hr/>
<h3>ewol::context::~<a id="InputManager">InputManager</a> ()</h3>
<pre>
~<span class="code-function">InputManager</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__key__type.html" class="code-type">ewol::key::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__key__type.html" class="code-type">ewol::key::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__Object.html" class="code-type">ewol::Object</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 Object remeved == > the user must remove all reference on this Object
<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 * <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__key__type.html" class="code-type">ewol::key::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 * <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__key__type.html" class="code-type">ewol::key::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__key__status.html" class="code-type">ewol::key::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__key__type.html" class="code-type">ewol::key::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