ewol/class_ewol__widget__Gird.html
2014-10-18 09:23:18 +02:00

308 lines
22 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__translate.html">translate</a>
</li>
<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><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>
<li><a href="namespace_IOs.html">IOs</a>
</li>
</ul>
</div>
<h3>Documentation:</h3><div id="menu">
<ul class="niveau1"><li><a href="001_bases.html">Bases</a></li>
</ul><ul class="niveau1"><li><a href="faq.html">Faq</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">Hello word</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_010_ObjectModel.html">Object model</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_011_ObjectConfig.html">Object config</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_012_ObjectMessage.html">Object message</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_020_FileAccess.html">File access</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_021_Resources.html">Resources</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_030_ConplexeXmlGui.html">Conplexe xml gui</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_050_CreateCustomWidget.html">Create custom widget</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_051_AddWidgetCustumInXML.html">Add widget custum in x m l</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::Gird</h1><hr/><h2>Constructor and Destructor:</h2>
<pre>
# <a class="code-function" href="#1429">Gird</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#1435">~Gird</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
# <span class="code-type" >void</span> <a class="code-function" href="#1430">init</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colNumber</span>);<br/>+ <a class="code-function" href="#1432">DECLARE_WIDGET_FACTORY</a> (Gird <span class="code-argument"></span>,<br/> "Gird" <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1436">setColNumber</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colNumber</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1438">setColSize</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_size</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1441">setRowSize</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_size</span>);<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#1443">getColSize</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>);<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#1445">getRowSize</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1446">setGravityButtom</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1447">setGravityTop</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1448">subWidgetRemoveAll</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1449">subWidgetAdd</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1453">subWidgetRemove</a> (<a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1455">subWidgetRemove</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1458">subWidgetUnLink</a> (<a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1460">subWidgetUnLink</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1464">setBorderSize</a> (<span class="code-storage-keyword">const</span> ivec2 & <span class="code-argument">_newBorderSize</span>);<br/>+ <span class="code-storage-keyword">const</span> ivec2 & <a class="code-function" href="#1466">getBorderSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1467">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="#1469">onRegenerateDisplay</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <a class="code-function" href="#1470">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" >void</span> <a class="code-function" href="#1472">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1474">calculateMinMaxSize</a> ();<br/></pre>
<br/>
<h2>Object Hierarchy:<h2>
<pre>
+std::enable_shared_from_this&lt;Object&gt;<br/>+<a href="class_ewol__object__ParameterList.html">ewol::object::ParameterList</a><br/>+<a href="class_ewol__object__SignalList.html">ewol::object::SignalList</a><br/> +--> +<a href="class_ewol__Object.html">ewol::Object</a><br/> +--> +<a href="class_ewol__Widget.html">ewol::Widget</a><br/> +--> ewol::widget::Gird<br/></pre>
<h2>Detail:</h2>
<a id="1429"/><a id="1430"/><h3>Gird</h3><pre>
# <span class="code-function">Gird</span> ();<br/></pre>
Constructor<br/>
<br/>
<hr/>
<a id="1432"/><h3>init</h3><pre>
# <span class="code-type" >void</span> <span class="code-function">init</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colNumber</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="1435"/><h3>DECLARE_WIDGET_FACTORY</h3><pre>
+ <span class="code-function">DECLARE_WIDGET_FACTORY</span> (Gird <span class="code-argument"></span>,<br/> "Gird" <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="1436"/><h3>~Gird</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Gird</span> ();<br/></pre>
Desstructor<br/>
<br/>
<hr/>
<a id="1438"/><h3>setColNumber</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setColNumber</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colNumber</span>);<br/></pre>
set the number of colomn<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">colNumber</span> </td><td> Nuber of colomn</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1441"/><h3>setColSize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setColSize</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_size</span>);<br/></pre>
change a size view of a colomn.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">colId</span> </td><td> Id of the colomn [0..x].</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">size</span> </td><td> size of the colomn.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1443"/><h3>setRowSize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setRowSize</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_size</span>);<br/></pre>
change a size view of a line.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">size</span> </td><td> size of the line.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1445"/><h3>getColSize</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getColSize</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>);<br/></pre>
get the size view of a colomn.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">colId</span> </td><td> Id of the colomn [0..x].</td></tr>
<tr><td><b>Return: </b></td><td></td><td>The size of the colomn.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="1446"/><h3>getRowSize</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getRowSize</span> ();<br/></pre>
get the size view of the lines.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The size of the lines.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="1447"/><h3>setGravityButtom</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setGravityButtom</span> ();<br/></pre>
set the gravity of the widget on the Button (index 0 is on buttom)<br/>
<br/>
<hr/>
<a id="1448"/><h3>setGravityTop</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setGravityTop</span> ();<br/></pre>
set the gravity of the widget on the Top (index 0 is on top)<br/>
<br/>
<hr/>
<a id="1449"/><h3>subWidgetRemoveAll</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetRemoveAll</span> ();<br/></pre>
remove all sub element from the widget.<br/>
<br/>
<hr/>
<a id="1453"/><h3>subWidgetAdd</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetAdd</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/></pre>
add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_colId</span> </td><td> Id of the colomn [0..x].</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_rowId</span> </td><td> Id of the row [0..y].</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newWidget</span> </td><td> the element pointer</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1455"/><h3>subWidgetRemove</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetRemove</span> (<a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/></pre>
remove definitly a widget from the system and this Gird.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newWidget</span> </td><td> the element pointer.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1458"/><h3>subWidgetRemove</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetRemove</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>);<br/></pre>
remove definitly a widget from the system and this Gird.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_colId</span> </td><td> Id of the colomn [0..x].</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_rowId</span> </td><td> Id of the row [0..y].</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1460"/><h3>subWidgetUnLink</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetUnLink</span> (<a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-argument">_newWidget</span>);<br/></pre>
Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newWidget</span> </td><td> the element pointer.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1464"/><h3>subWidgetUnLink</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">subWidgetUnLink</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_colId</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_rowId</span>);<br/></pre>
Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_colId</span> </td><td> Id of the colomn [0..x].</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_rowId</span> </td><td> Id of the row [0..y].</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1466"/><h3>setBorderSize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setBorderSize</span> (<span class="code-storage-keyword">const</span> ivec2 & <span class="code-argument">_newBorderSize</span>);<br/></pre>
set the current border size of the current element:<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newBorderSize</span> </td><td> The border size to set (0 if not used)</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="1467"/><h3>getBorderSize</h3><pre>
+ <span class="code-storage-keyword">const</span> ivec2 & <span class="code-function">getBorderSize</span> ();<br/></pre>
get the current border size of the current element:<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the border size (0 if not used)</td></tr></table>
</ul>
<br/>
<hr/>
<a id="1469"/><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="1470"/><h3>onRegenerateDisplay</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onRegenerateDisplay</span> ();<br/></pre>
Event generated when a redraw is needed<br/>
<br/>
<hr/>
<a id="1472"/><h3>getWidgetAtPos</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <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>nullptr No widget found&lt;br/&gt;pointer on the widget found</td></tr></table>
</ul>
<br/>
<hr/>
<a id="1474"/><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">_availlable</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/>
<h3>calculateMinMaxSize</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateMinMaxSize</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/>
</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>