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

293 lines
21 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><a href="index.html">ewol library</a></h1>
<h4><a href="http://github.com/heeroyui/ewol/">&nbsp;&nbsp;&nbsp;[ 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::widget::PopUp</h1><hr/><h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#2242">PopUp</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">_shaperName</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#2244">~PopUp</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-type" >void</span> <a class="code-function" href="#2235">init</a> (<a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2237">configShaper</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2238">configRemoveOnExternClick</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2239">configAnimation</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2240">configLockExpand</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2246">setShaperName</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">_shaperName</span>);<br/># bvec2 <a class="code-member" href="#2248">m_lockExpand</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2249">lockExpand</a> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_lockExpand</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2252">setRemoveOnExternClick</a> (<span class="code-type" >bool</span> <span class="code-argument">_state</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#2254">getRemoveOnExternClick</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2256">onDraw</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2258">onSetConfig</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__Config.html">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2260">onGetConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_result</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2263">periodicCall</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2265">systemDraw</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__DrawProperty.html">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2267">onRegenerateDisplay</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="#2269">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_available</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2271">onEventInput</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Input.html">ewol::event::Input</a> & <span class="code-argument">_event</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <a class="code-function" href="#2273">getWidgetAtPos</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" >bool</span> <a class="code-function" href="#2275">onStartAnnimation</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2277">onStopAnnimation</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Object Hierarchy:<h2>
<pre>
+<a href="class_ewol__Object.html">ewol::Object</a><br/> +--> +<a href="class_ewol__Widget.html">ewol::Widget</a><br/> +--> +<a href="class_ewol__widget__Container.html">ewol::widget::Container</a><br/> +--> ewol::widget::PopUp<br/> +--> <a href="class_ewol__widget__Parameter.html">ewol::widget::Parameter</a><br/> +--> <a href="class_ewol__widget__FileChooser.html">ewol::widget::FileChooser</a><br/> +--> <a href="class_ewol__widget__StdPopUp.html">ewol::widget::StdPopUp</a><br/></pre>
<h2>Detail:</h2>
<a id="2235"/><a id="2237"/><h3>init</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">init</span> (<a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="2238"/><h3>configShaper</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configShaper</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2239"/><h3>configRemoveOnExternClick</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configRemoveOnExternClick</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2240"/><h3>configAnimation</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configAnimation</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2242"/><h3>configLockExpand</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configLockExpand</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2244"/><h3>PopUp</h3><pre>
+ <span class="code-function">PopUp</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">_shaperName</span>);<br/></pre>
Constructor<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_shaperName</span> </td><td> Shaper file properties</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2246"/><h3>~PopUp</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~PopUp</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Destructor<br/>
<br/>
<hr/>
<a id="2248"/><h3>setShaperName</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setShaperName</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">_shaperName</span>);<br/></pre>
set the shaper name (use the contructer one this permit to not noad unused shaper)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_shaperName</span> </td><td> The new shaper filename</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2249"/><h3>m_lockExpand</h3><pre>
# bvec2 <span class="code-member">m_lockExpand</span>;<br/></pre>
Lock the expend of the sub widget to this one == &gt; this permit to limit bigger subWidget<br/>
<br/>
<hr/>
<a id="2252"/><h3>lockExpand</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">lockExpand</span> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_lockExpand</span>);<br/></pre>
Limit the expend properties to the current widget (no contamination)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_lockExpend</span> </td><td> Lock mode of the expend properties</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2254"/><h3>setRemoveOnExternClick</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setRemoveOnExternClick</span> (<span class="code-type" >bool</span> <span class="code-argument">_state</span>);<br/></pre>
Request the Auto-remove when the event input is set outside the widget<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_state</span> </td><td> New status</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2256"/><h3>getRemoveOnExternClick</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">getRemoveOnExternClick</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the status of the request the Auto-remove when the event input is set outside the widget.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the status of the removing</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2258"/><h3>onDraw</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onDraw</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Common widget drawing function (called by the drawing thread [Android, X11, ...])<br/>
<br/>
<hr/>
<a id="2260"/><h3>onSetConfig</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onSetConfig</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__Config.html">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br/></pre>
Configuration requested to the curent Object<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_conf</span> </td><td> Configuration handle.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true if the parametere has been used</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2263"/><h3>onGetConfig</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onGetConfig</span> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_result</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
Receive a configuration message from an other element system or from the curent Object<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_config</span> </td><td> Configuration name.</td></tr>
<td><b>Parameter [output]:</b></td><td><span class="code-argument">_result</span> </td><td> Result of the request.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true if the config is set</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2265"/><h3>periodicCall</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">periodicCall</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/></pre>
periodic call of this widget<br/><ul>
<table class="parameter-list">
<td><b>Parameter:</b></td><td><span class="code-argument">_event</span> </td><td> Current time property</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2267"/><h3>systemDraw</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">systemDraw</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__DrawProperty.html">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</span>);<br/></pre>
{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...])
This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget<br/><b>Note:</b> This function is virtual for the scrolled widget, and the more complicated openGl widget<br/> <b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displayProp</span> </td><td> properties of the current display</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2269"/><h3>onRegenerateDisplay</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onRegenerateDisplay</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Event generated when a redraw is needed<br/>
<br/>
<hr/>
<a id="2271"/><h3>calculateSize</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateSize</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_available</span>);<br/></pre>
Parent set the possible diplay size of the current widget whith his own possibilities
By default this save the widget available size in the widget size<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_available</span> </td><td> Available x&y pixel size</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2273"/><h3>onEventInput</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onEventInput</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Input.html">ewol::event::Input</a> & <span class="code-argument">_event</span>);<br/></pre>
Event on an input of this Widget (finger, mouse, stilet)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_event</span> </td><td> Event properties</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true the event is used&lt;br/&gt;false the event is not used</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2275"/><h3>getWidgetAtPos</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-function">getWidgetAtPos</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">pos</span>);<br/></pre>
get the widget at the specific windows absolute position<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_pos</span> </td><td> gAbsolute position of the requested widget knowledge</td></tr>
<tr><td><b>Return: </b></td><td></td><td>NULL No widget found&lt;br/&gt;pointer on the widget found</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2277"/><h3>onStartAnnimation</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onStartAnnimation</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/></pre>
Event when start the annimation.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true need to add periodic call.</td></tr></table>
</ul>
<br/>
<hr/>
<h3>onStopAnnimation</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onStopAnnimation</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Event when Stop the annimation.<br/>
<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>
Reference in New Issue View Git Blame Copy Permalink