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

276 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__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::WSlider</h1><hr/><h2>enum:</h2>
<ul>
<li><a href="enum_ewol__widget__WSlider__sladingMode.html">sladingMode</a></li></ul>
<h2>Constructor and Destructor:</h2>
<pre>
# <a class="code-function" href="#867">WSlider</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#872">~WSlider</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a>&lt;void&gt; <a class="code-member" href="#864">signalStartSlide</a>;<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a>&lt;void&gt; <a class="code-member" href="#865">signalStopSlide</a>;<br/># <span class="code-type" >void</span> <a class="code-function" href="#868">init</a> ();<br/>+ <a class="code-function" href="#869">DECLARE_WIDGET_FACTORY</a> (WSlider <span class="code-argument"></span>,<br/> "WSlider" <span class="code-argument"></span>);<br/># <span class="code-type" >void</span> <a class="code-function" href="#878">subWidgetSelectSetVectorId</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#880">subWidgetSelectSet</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#882">subWidgetSelectSet</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;ewol::Widget&gt; & <span class="code-argument">_widgetPointer</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#884">subWidgetSelectSet</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">_widgetName</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#887">setTransitionSpeed</a> (<span class="code-type" >float</span> <span class="code-argument">_timeSecond</span>);<br/>+ <span class="code-type" >float</span> <a class="code-function" href="#889">getTransitionSpeed</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#891">setTransitionMode</a> (<span class="code-storage-keyword">enum</span> sladingMode <span class="code-argument">_mode</span>);<br/>+ <span class="code-storage-keyword">enum</span> sladingMode <a class="code-function" href="#893">getTransitionMode</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#894">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="#896">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="#898">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="#899">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="#901">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="#903">onParameterChangeValue</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__ParameterRef.html">ewol::object::ParameterRef</a> & <span class="code-argument">_paramPointer</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/> +--> +<a href="class_ewol__widget__ContainerN.html">ewol::widget::ContainerN</a><br/> +--> ewol::widget::WSlider<br/></pre>
<h2>Detail:</h2>
<a id="864"/><a id="865"/><h3>signalStartSlide</h3><pre>
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a>&lt;void&gt; <span class="code-member">signalStartSlide</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="867"/><h3>signalStopSlide</h3><pre>
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a>&lt;void&gt; <span class="code-member">signalStopSlide</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="868"/><h3>WSlider</h3><pre>
# <span class="code-function">WSlider</span> ();<br/></pre>
<br/>
<br/>
<hr/>
<a id="869"/><h3>init</h3><pre>
# <span class="code-type" >void</span> <span class="code-function">init</span> ();<br/></pre>
<br/>
<br/>
<hr/>
<a id="872"/><h3>DECLARE_WIDGET_FACTORY</h3><pre>
+ <span class="code-function">DECLARE_WIDGET_FACTORY</span> (WSlider <span class="code-argument"></span>,<br/> "WSlider" <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="878"/><h3>~WSlider</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~WSlider</span> ();<br/></pre>
<br/>
<br/>
<hr/>
<a id="880"/><h3>subWidgetSelectSetVectorId</h3><pre>
# <span class="code-type" >void</span> <span class="code-function">subWidgetSelectSetVectorId</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...)<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_id</span> </td><td> Id in the vector</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="882"/><h3>subWidgetSelectSet</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetSelectSet</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
Select a new subwidget to 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 subwidget requested</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="884"/><h3>subWidgetSelectSet</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetSelectSet</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;ewol::Widget&gt; & <span class="code-argument">_widgetPointer</span>);<br/></pre>
Select a new subwidget to display<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_widgetPointer</span> </td><td> Pointer on the widget selected (must be added before)</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="887"/><h3>subWidgetSelectSet</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">subWidgetSelectSet</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">_widgetName</span>);<br/></pre>
Select a new subwidget to display<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_widgetName</span> </td><td> Name of the subwidget name</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="889"/><h3>setTransitionSpeed</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setTransitionSpeed</span> (<span class="code-type" >float</span> <span class="code-argument">_timeSecond</span>);<br/></pre>
set transition speed element.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_timeSecond</span> </td><td> number of second needed to do the transition.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="891"/><h3>getTransitionSpeed</h3><pre>
+ <span class="code-type" >float</span> <span class="code-function">getTransitionSpeed</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get transition speed element.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>number of second needed to do the transition.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="893"/><h3>setTransitionMode</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setTransitionMode</span> (<span class="code-storage-keyword">enum</span> sladingMode <span class="code-argument">_mode</span>);<br/></pre>
set a new mode of sliding element<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> new display mode</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="894"/><h3>getTransitionMode</h3><pre>
+ <span class="code-storage-keyword">enum</span> sladingMode <span class="code-function">getTransitionMode</span> ();<br/></pre>
get a new mode of sliding element<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The current sliding mode</td></tr></table>
</ul>
<br/>
<hr/>
<a id="896"/><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="898"/><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="899"/><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="901"/><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="903"/><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/>
<h3>onParameterChangeValue</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onParameterChangeValue</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__ParameterRef.html">ewol::object::ParameterRef</a> & <span class="code-argument">_paramPointer</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>