486 lines
44 KiB
HTML
486 lines
44 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__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 class="sousmenu"><a href="namespace_ewol__audio.html">audio</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__audio__wav.html">wav</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__audio__music.html">music</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__audio__effects.html">effects</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_ewol__portAudio.html">portAudio</a>
|
|
</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>
|
|
</ul>
|
|
</div>
|
|
<h3>Documentation:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="001_bases.html">bases</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">HelloWord</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::Context</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>Associated Namespace:</h2><ul>
|
|
<a href="namespace_ewol__context.html">context</a></ul>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#3992">Context</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_argc</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_argv</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#3995">~Context</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-type" href="class_ewol__context__CommandLine.html">ewol::context::CommandLine</a> & <a class="code-function" href="#3978">getCmd</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_ewol__context__ConfigFont.html">ewol::context::ConfigFont</a> & <a class="code-function" href="#3981">getFontDefault</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <a class="code-function" href="#3984">getWidgetManager</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_ewol__object__Manager.html">ewol::object::Manager</a> & <a class="code-function" href="#3987">getEObjectManager</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_ewol__resource__Manager.html">ewol::resource::Manager</a> & <a class="code-function" href="#3990">getResourcesManager</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-type" >void</span> <a class="code-function" href="#3997">lockContext</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-type" >void</span> <a class="code-function" href="#3999">unLockContext</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4011">setArchiveDir</a> (<span class="code-type" >int</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_str</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4014">OS_SetInputMotion</a> (<span class="code-type" >int</span> <span class="code-argument">_pointerID</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4017">OS_SetInputState</a> (<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/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4021">OS_SetMouseMotion</a> (<span class="code-type" >int</span> <span class="code-argument">_pointerID</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4024">OS_SetMouseState</a> (<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/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4028">OS_SetKeyboard</a> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <span class="code-type" >char32_t</span> <span class="code-argument">_myChar</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isARepeateKey</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4033">OS_SetKeyboardMove</a> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <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/> <span class="code-type" >bool</span> <span class="code-argument">_isARepeateKey</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4038">OS_Suspend</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4040">OS_Resume</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4042">requestUpdateSize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#4044">OS_Draw</a> (<span class="code-type" >bool</span> <span class="code-argument">_displayEveryTime</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4046">onObjectRemove</a> (<a class="code-type" href="class_ewol__Object.html">ewol::Object</a>* <span class="code-argument">_removeObject</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4048">resetIOEvent</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4050">OS_OpenGlContextDestroy</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4052">OS_Stop</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4054">stop</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4057">setWindows</a> (<a class="code-type" href="class_ewol__widget__Windows.html">ewol::widget::Windows</a>* <span class="code-argument">_windows</span>);<br/>+ <a class="code-type" href="class_ewol__widget__Windows.html">ewol::widget::Windows</a>* <a class="code-function" href="#4059">getWindows</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">const</span> vec2 & <a class="code-function" href="#4062">getSize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4064">OS_Resize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4066">setSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4068">OS_Move</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4070">setPos</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4072">OS_Hide</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4074">hide</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4076">OS_Show</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4078">show</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4080">forceRedrawAll</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4082">inputEventTransfertWidget</a> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_source</span>,<br/> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_destination</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4085">inputEventGrabPointer</a> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4087">inputEventUnGrabPointer</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4089">keyboardShow</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4091">keyboardHide</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4093">clipBoardGet</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4095">clipBoardSet</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4097">OS_ClipBoardArrive</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4099">setTitle</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_title</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4101">forceOrientation</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__orientation.html">ewol::orientation</a> <span class="code-argument">_orientation</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4103">grabPointerEvents</a> (<span class="code-type" >bool</span> <span class="code-argument">_isGrabbed</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_forcedPosition</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4106">setCursor</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <span class="code-argument">_newCursor</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#4108">setIcon</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_inputFile</span>);<br/>+ <span class="code-type" >int64_t</span> <a class="code-function" href="#4110">getTime</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >int</span> <a class="code-function" href="#4112">main</a> (<span class="code-type" >int</span> <span class="code-argument">_argc</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_argv</span>);<br/></pre>
|
|
<br/>
|
|
<h2>Detail:</h2>
|
|
<a id="3978"/><a id="3981"/><h3>getCmd</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__context__CommandLine.html">ewol::context::CommandLine</a> & <span class="code-function">getCmd</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3984"/><h3>getFontDefault</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__context__ConfigFont.html">ewol::context::ConfigFont</a> & <span class="code-function">getFontDefault</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3987"/><h3>getWidgetManager</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-function">getWidgetManager</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3990"/><h3>getEObjectManager</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Manager.html">ewol::object::Manager</a> & <span class="code-function">getEObjectManager</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3992"/><h3>getResourcesManager</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__resource__Manager.html">ewol::resource::Manager</a> & <span class="code-function">getResourcesManager</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3995"/><h3>Context</h3><pre>
|
|
+ <span class="code-function">Context</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_argc</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_argv</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3997"/><h3>~Context</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Context</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3999"/><h3>lockContext</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">lockContext</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
set the curent interface.<br/><b>Note:</b> this lock the main mutex<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4011"/><h3>unLockContext</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">unLockContext</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
set the curent interface at NULL.<br/><b>Note:</b> this un-lock the main mutex<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4014"/><h3>setArchiveDir</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setArchiveDir</span> (<span class="code-type" >int</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_str</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4017"/><h3>OS_SetInputMotion</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetInputMotion</span> (<span class="code-type" >int</span> <span class="code-argument">_pointerID</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4021"/><h3>OS_SetInputState</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetInputState</span> (<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/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4024"/><h3>OS_SetMouseMotion</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetMouseMotion</span> (<span class="code-type" >int</span> <span class="code-argument">_pointerID</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4028"/><h3>OS_SetMouseState</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetMouseState</span> (<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/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4033"/><h3>OS_SetKeyboard</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetKeyboard</span> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <span class="code-type" >char32_t</span> <span class="code-argument">_myChar</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isARepeateKey</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4038"/><h3>OS_SetKeyboardMove</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_SetKeyboardMove</span> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <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/> <span class="code-type" >bool</span> <span class="code-argument">_isARepeateKey</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4040"/><h3>OS_Suspend</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_Suspend</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The current context is suspended<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4042"/><h3>OS_Resume</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_Resume</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The current context is resumed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4044"/><h3>requestUpdateSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">requestUpdateSize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4046"/><h3>OS_Draw</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">OS_Draw</span> (<span class="code-type" >bool</span> <span class="code-argument">_displayEveryTime</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4048"/><h3>onObjectRemove</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">onObjectRemove</span> (<a class="code-type" href="class_ewol__Object.html">ewol::Object</a>* <span class="code-argument">_removeObject</span>);<br/></pre>
|
|
Inform object that an other object is removed ...<br/><b>Note:</b> : Sub classes must call this class<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">removeObject</span> </td><td> Pointer on the EObject removed == > the user must remove all reference on this EObject</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4050"/><h3>resetIOEvent</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">resetIOEvent</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
reset event management for the IO like Input ou Mouse or keyborad<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4052"/><h3>OS_OpenGlContextDestroy</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_OpenGlContextDestroy</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The OS inform that the openGL constext has been destroy == > use to automaticly reload the texture and other thinks ...<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4054"/><h3>OS_Stop</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_Stop</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The OS Inform that the Window has been killed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4057"/><h3>stop</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">stop</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The application request that the Window will be killed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4059"/><h3>setWindows</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setWindows</span> (<a class="code-type" href="class_ewol__widget__Windows.html">ewol::widget::Windows</a>* <span class="code-argument">_windows</span>);<br/></pre>
|
|
set the current windows to display :<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter:</b></td><td><span class="code-argument">_windows</span> </td><td> Windows that might be displayed</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4062"/><h3>getWindows</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__widget__Windows.html">ewol::widget::Windows</a>* <span class="code-function">getWindows</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the current windows that is displayed<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the current handle on the windows (can be null)</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4064"/><h3>getSize</h3><pre>
|
|
+ <span class="code-storage-keyword">const</span> vec2 & <span class="code-function">getSize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the current windows size<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the current size ...</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4066"/><h3>OS_Resize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">OS_Resize</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/></pre>
|
|
The OS inform that the current windows has change his size.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> new size of the windows.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4068"/><h3>setSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setSize</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/></pre>
|
|
The application request a change of his curent size.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> new Requested size of the windows.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4070"/><h3>OS_Move</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_Move</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
The OS inform that the current windows has change his position.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_pos</span> </td><td> New position of the Windows.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4072"/><h3>setPos</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setPos</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
The Application request that the current windows will change his position.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_pos</span> </td><td> New position of the Windows requested.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4074"/><h3>OS_Hide</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_Hide</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The OS inform that the Windows is now Hidden.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4076"/><h3>hide</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">hide</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The Application request that the Windows will be Hidden.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4078"/><h3>OS_Show</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_Show</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The OS inform that the Windows is now visible.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4080"/><h3>show</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">show</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
The Application request that the Windows will be visible.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4082"/><h3>forceRedrawAll</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">forceRedrawAll</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Redraw all the windows<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4085"/><h3>inputEventTransfertWidget</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">inputEventTransfertWidget</span> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_source</span>,<br/> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_destination</span>);<br/></pre>
|
|
This is to transfert the event from one widget to another one<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter:</b></td><td><span class="code-argument">source</span> </td><td> the widget where the event came from</td></tr>
|
|
<td><b>Parameter:</b></td><td><span class="code-argument">destination</span> </td><td> the widget where the event mitgh be generated now</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4087"/><h3>inputEventGrabPointer</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">inputEventGrabPointer</span> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/></pre>
|
|
This fonction lock the pointer properties to move in relative instead of absolute<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">widget</span> </td><td> The widget that lock the pointer events</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4089"/><h3>inputEventUnGrabPointer</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">inputEventUnGrabPointer</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
This fonction un-lock the pointer properties to move in relative instead of absolute<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4091"/><h3>keyboardShow</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">keyboardShow</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
display the virtal keyboard (for touch system only)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4093"/><h3>keyboardHide</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">keyboardHide</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Hide the virtal keyboard (for touch system only)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="4095"/><h3>clipBoardGet</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">clipBoardGet</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/></pre>
|
|
Inform the Gui that we want to have a copy of the clipboard<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_clipboardID</span> </td><td> ID of the clipboard (STD/SELECTION) only apear here</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4097"/><h3>clipBoardSet</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">clipBoardSet</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/></pre>
|
|
Inform the Gui that we are the new owner of the clipboard<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_clipboardID</span> </td><td> ID of the clipboard (STD/SELECTION) only apear here</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4099"/><h3>OS_ClipBoardArrive</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">OS_ClipBoardArrive</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/></pre>
|
|
Call by the OS when a clipboard arrive to US (previously requested by a widget)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">Id</span> </td><td> of the clipboard</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4101"/><h3>setTitle</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setTitle</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_title</span>);<br/></pre>
|
|
set the new title of the windows<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">title</span> </td><td> New desired title</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4103"/><h3>forceOrientation</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">forceOrientation</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__orientation.html">ewol::orientation</a> <span class="code-argument">_orientation</span>);<br/></pre>
|
|
force the screen orientation (availlable on portable elements ...<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_orientation</span> </td><td> Selected orientation.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4106"/><h3>grabPointerEvents</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">grabPointerEvents</span> (<span class="code-type" >bool</span> <span class="code-argument">_isGrabbed</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_forcedPosition</span>);<br/></pre>
|
|
get all the event from the X system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_isGrabbed</span> </td><td> "true" if all the event will be get, false if we want only ours.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_forcedPosition</span> </td><td> the position where the mouse might be reset at every events ...</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4108"/><h3>setCursor</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setCursor</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <span class="code-argument">_newCursor</span>);<br/></pre>
|
|
set the cursor display type.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newCursor</span> </td><td> selected new cursor.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4110"/><h3>setIcon</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setIcon</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_inputFile</span>);<br/></pre>
|
|
set the Icon of the program<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_inputFile</span> </td><td> new filename icon of the curent program.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="4112"/><h3>getTime</h3><pre>
|
|
+ <span class="code-type" >int64_t</span> <span class="code-function">getTime</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the curent time in micro-second<br/><b>Note:</b> : must be implemented in all system OS implementation<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The curent time of the process</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>main</h3><pre>
|
|
+ <span class="code-type" >int</span> <span class="code-function">main</span> (<span class="code-type" >int</span> <span class="code-argument">_argc</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_argv</span>);<br/></pre>
|
|
This is the only one things the User might done in his main();<br/><b>Note:</b> : must be implemented in all system OPS implementation<br/> <b>Note:</b> To answare you before you ask the question, this is really simple:
|
|
Due to the fect that the current system is multiple-platform, you "main"
|
|
Does not exist in the android platform, then ewol call other start
|
|
and stop function, to permit to have only one code<br/> <b>Note:</b> The main can not be in the ewol, due to the fact thet is an librairy<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_argc</span> </td><td> Standard argc</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_argv</span> </td><td> Standard argv</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>normal error int for the application error management</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>
|