atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/class_ewol__widget__Container2.html
Edouard DUPIN e39f62d9f6 [DOC] update doc
2014-10-18 09:23:18 +02:00

305 lines
22 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__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::Container2</h1><hr/><h2>Description:</h2>
the Cotainer widget is a widget that have an only one subWidget<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
# <a class="code-function" href="#639">Container2</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#643">~Container2</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
# <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <a class="code-member" href="#637">m_subWidget</a>;<br/># <span class="code-type" >int32_t</span> <a class="code-member" href="#638">m_idWidgetDisplayed</a>;<br/># <span class="code-type" >void</span> <a class="code-function" href="#640">init</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">_subElement</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">_subElementToggle</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#647">setSubWidget</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">_subWidget</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#649">setSubWidgetToggle</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">_subWidget</span>);<br/>+ <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="#653">getSubWidget</a> () <span class="code-storage-keyword">const</span>;<br/>+ <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="#654">getSubWidgetToggle</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#657">subWidgetRemove</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#658">subWidgetRemoveToggle</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#661">subWidgetUnLink</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#662">subWidgetUnLinkToggle</a> ();<br/># <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> <a class="code-function" href="#663">calculateSizePadded</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> & <span class="code-argument">_padding</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#666">calculateMinMaxSizePadded</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> & <span class="code-argument">_padding</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#668">onDetectPresenceToggleWidget</a> ();<br/># <span class="code-type" >int32_t</span> <a class="code-function" href="#669">convertId</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="#671">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="#673">onRegenerateDisplay</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#674">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="#676">calculateMinMaxSize</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::Object&gt; <a class="code-function" href="#677">getSubObjectNamed</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">_objectName</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#679">loadXML</a> (<a class="code-type" href="class_exml__Element.html">exml::Element</a>* <span class="code-argument">_node</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#681">setOffset</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newVal</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#683">requestDestroyFromChild</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;Object&gt; & <span class="code-argument">_child</span>);<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::Container2<br/> +--> <a href="class_ewol__widget__Button.html">ewol::widget::Button</a><br/> +--> <a href="class_ewol__widget__CheckBox.html">ewol::widget::CheckBox</a><br/></pre>
<h2>Detail:</h2>
<a id="637"/><a id="638"/><h3>m_subWidget</h3><pre>
# <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;ewol::Widget&gt; <span class="code-member">m_subWidget</span>;<br/></pre>
2 subwidget possible<br/>
<br/>
<hr/>
<a id="639"/><h3>m_idWidgetDisplayed</h3><pre>
# <span class="code-type" >int32_t</span> <span class="code-member">m_idWidgetDisplayed</span>;<br/></pre>
current widget displayed<br/>
<br/>
<hr/>
<a id="640"/><h3>Container2</h3><pre>
# <span class="code-function">Container2</span> ();<br/></pre>
Constructor<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_subElement</span> </td><td> Widget to set on the normal position</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_subElementToggle</span> </td><td> Widget to set on the toggle position</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="643"/><h3>init</h3><pre>
# <span class="code-type" >void</span> <span class="code-function">init</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">_subElement</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">_subElementToggle</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="647"/><h3>~Container2</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Container2</span> ();<br/></pre>
Destructor<br/>
<br/>
<hr/>
<a id="649"/><h3>setSubWidget</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setSubWidget</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">_subWidget</span>);<br/></pre>
Specify the current widget<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_subWidget</span> </td><td> Widget to add normal</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="653"/><h3>setSubWidgetToggle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setSubWidgetToggle</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">_subWidget</span>);<br/></pre>
Specify the current toggle widget<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_subWidget</span> </td><td> Widget to add Toggle</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="654"/><h3>getSubWidget</h3><pre>
+ <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">getSubWidget</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current displayed composition<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The base widget</td></tr></table>
</ul>
<br/>
<hr/>
<a id="657"/><h3>getSubWidgetToggle</h3><pre>
+ <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">getSubWidgetToggle</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current displayed composition<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The toggle widget</td></tr></table>
</ul>
<br/>
<hr/>
<a id="658"/><h3>subWidgetRemove</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetRemove</span> ();<br/></pre>
remove the subWidget node (async).<br/>
<br/>
<hr/>
<a id="661"/><h3>subWidgetRemoveToggle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetRemoveToggle</span> ();<br/></pre>
remove the subWidget Toggle node (async).<br/>
<br/>
<hr/>
<a id="662"/><h3>subWidgetUnLink</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetUnLink</span> ();<br/></pre>
Unlink the subwidget Node.<br/>
<br/>
<hr/>
<a id="663"/><h3>subWidgetUnLinkToggle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetUnLinkToggle</span> ();<br/></pre>
Unlink the subwidget Toggle Node.<br/>
<br/>
<hr/>
<a id="666"/><h3>calculateSizePadded</h3><pre>
# <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> <span class="code-function">calculateSizePadded</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> & <span class="code-argument">_padding</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>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_padding</span> </td><td> Padding of the widget.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="668"/><h3>calculateMinMaxSizePadded</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateMinMaxSizePadded</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Padding.html">ewol::Padding</a> & <span class="code-argument">_padding</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/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_padding</span> </td><td> Padding of the widget.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="669"/><h3>onDetectPresenceToggleWidget</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onDetectPresenceToggleWidget</span> ();<br/></pre>
Called when parsing a XML and detect the presence of a second Widget<br/>
<br/>
<hr/>
<a id="671"/><h3>convertId</h3><pre>
# <span class="code-type" >int32_t</span> <span class="code-function">convertId</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
convert ID of the widget if not existed<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_id</span> </td><td> Id of the widget to display.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>the id of the widget displayable</td></tr></table>
</ul>
<br/>
<hr/>
<a id="673"/><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="674"/><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="676"/><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/>
<a id="677"/><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/>
<a id="679"/><h3>getSubObjectNamed</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::Object&gt; <span class="code-function">getSubObjectNamed</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">_objectName</span>);<br/></pre>
Retrive an object with his name (in the global list)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_name</span> </td><td> Name of the object</td></tr>
<tr><td><b>Return: </b></td><td></td><td>the requested object or nullptr</td></tr></table>
</ul>
<br/>
<hr/>
<a id="681"/><h3>loadXML</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">loadXML</span> (<a class="code-type" href="class_exml__Element.html">exml::Element</a>* <span class="code-argument">_node</span>);<br/></pre>
load properties with an XML node.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_node</span> </td><td> Pointer on the tinyXML node.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true : All has been done corectly.&lt;br/&gt;false : An error occured.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="683"/><h3>setOffset</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setOffset</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newVal</span>);<br/></pre>
set the zoom property of the widget.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newVal</span> </td><td> offset value.</td></tr>
</table>
</ul>
<br/>
<hr/>
<h3>requestDestroyFromChild</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">requestDestroyFromChild</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a>&lt;Object&gt; & <span class="code-argument">_child</span>);<br/></pre>
<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