ewol/class_ewol__widget__List.html

216 lines
18 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/">&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::List</h1><hr/><h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#3233">List</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#3235">~List</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#3237">calculateMinMaxSize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3239">setLabel</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_newLabel</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3243">addOObject</a> (<a class="code-type" href="class_ewol__Compositing.html">ewol::Compositing</a>* <span class="code-argument">_newObject</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_pos</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3246">clearOObjectList</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; <a class="code-function" href="#3253">getBasicBG</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >uint32_t</span> <a class="code-function" href="#3255">getNuberOfColomn</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="#3257">getTitle</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_myTitle</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_fg</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_bg</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >uint32_t</span> <a class="code-function" href="#3262">getNuberOfRaw</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="#3264">getElement</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_raw</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_myTextToWrite</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_fg</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_bg</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#3270">onItemEvent</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_IdInput</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__status.html">ewol::key::status</a> <span class="code-argument">_typeEvent</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_raw</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_x</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_y</span>);<br/># <span class="code-type" >void</span> <a class="code-function" href="#3277">setRawVisible</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#3279">onGetFocus</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="#3281">onLostFocus</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="#3283">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" >void</span> <a class="code-function" href="#3285">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" >bool</span> <a class="code-function" href="#3287">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/></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__WidgetScrooled.html">ewol::widget::WidgetScrooled</a><br/> +--> ewol::widget::List<br/> +--> <a href="class_ewol__widget__ListFileSystem.html">ewol::widget::ListFileSystem</a><br/></pre>
<h2>Detail:</h2>
<a id="3233"/><a id="3235"/><h3>List</h3><pre>
+ <span class="code-function">List</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3237"/><h3>~List</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~List</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3239"/><h3>calculateMinMaxSize</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateMinMaxSize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
calculate the minimum and maximum size (need to estimate expend properties of the widget)<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/>
<br/>
<hr/>
<a id="3243"/><h3>setLabel</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setLabel</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_newLabel</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3246"/><h3>addOObject</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">addOObject</span> (<a class="code-type" href="class_ewol__Compositing.html">ewol::Compositing</a>* <span class="code-argument">_newObject</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_pos</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3253"/><h3>clearOObjectList</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">clearOObjectList</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3255"/><h3>getBasicBG</h3><pre>
# <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; <span class="code-function">getBasicBG</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3257"/><h3>getNuberOfColomn</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >uint32_t</span> <span class="code-function">getNuberOfColomn</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3262"/><h3>getTitle</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">getTitle</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_myTitle</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_fg</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_bg</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3264"/><h3>getNuberOfRaw</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >uint32_t</span> <span class="code-function">getNuberOfRaw</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3270"/><h3>getElement</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">getElement</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_raw</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_myTextToWrite</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_fg</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;&gt; & <span class="code-argument">_bg</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3277"/><h3>onItemEvent</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onItemEvent</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_IdInput</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__status.html">ewol::key::status</a> <span class="code-argument">_typeEvent</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_colomn</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_raw</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_x</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_y</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3279"/><h3>setRawVisible</h3><pre>
# <span class="code-type" >void</span> <span class="code-function">setRawVisible</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
set a raw visible in the main display<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_id</span> </td><td> Id of the raw that might be visible.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="3281"/><h3>onGetFocus</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onGetFocus</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Event of the focus has been grep by the current widget<br/>
<br/>
<hr/>
<a id="3283"/><h3>onLostFocus</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onLostFocus</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Event of the focus has been lost by the current widget<br/>
<br/>
<hr/>
<a id="3285"/><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="3287"/><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/>
<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/>
</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>