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

192 lines
11 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::object::Parameter</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#2926">Parameter</a> (<a class="code-type" href="class_ewol__object__ParameterList.html">ewol::object::ParameterList</a> & <span class="code-argument">_objectLink</span>,<br/> <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">_name</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#2929">~Parameter</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-type" >void</span> <a class="code-function" href="#2930">notifyChange</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#2931">getName</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#2932">getType</a> () = 0 <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#2933">getString</a> () = 0 <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#2934">getDefault</a> () = 0 <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="#2935">setString</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">_newVal</span>) = 0;<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-function" href="#2937">getInfo</a> () = 0 <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2938">isDefault</a> () = 0 <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="#2939">setDefault</a> () = 0;<br/></pre>
<br/>
<h2>Detail:</h2>
<a id="2926"/><a id="2929"/><h3>Parameter</h3><pre>
+ <span class="code-function">Parameter</span> (<a class="code-type" href="class_ewol__object__ParameterList.html">ewol::object::ParameterList</a> & <span class="code-argument">_objectLink</span>,<br/> <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">_name</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="2930"/><h3>~Parameter</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Parameter</span> ();<br/></pre>
<br/>
<br/>
<hr/>
<a id="2931"/><h3>notifyChange</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">notifyChange</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
call main class that parameterChange<br/>
<br/>
<hr/>
<a id="2932"/><h3>getName</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getName</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
Get the name of the parameter.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The name of the parameter</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2933"/><h3>getType</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getType</span> () = 0 <span class="code-storage-keyword">const</span>;<br/></pre>
Get the type of the parameter in string mode.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The string type of the parameter.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2934"/><h3>getString</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getString</span> () = 0 <span class="code-storage-keyword">const</span>;<br/></pre>
Get the string of the current value of the parameter.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The string description of the value.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2935"/><h3>getDefault</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getDefault</span> () = 0 <span class="code-storage-keyword">const</span>;<br/></pre>
Get the string of the default value of the parameter.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the string decription of the default value.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2937"/><h3>setString</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setString</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">_newVal</span>) = 0;<br/></pre>
Set a new value of the parameter (with string interface).<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newVal</span> </td><td> New value of the parameters.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2938"/><h3>getInfo</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-function">getInfo</span> () = 0 <span class="code-storage-keyword">const</span>;<br/></pre>
Description of the parameters.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>Descriptive information of the parameter (for remote UI).</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2939"/><h3>isDefault</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">isDefault</span> () = 0 <span class="code-storage-keyword">const</span>;<br/></pre>
Check if the value is the default<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>true : the vakue is the default one, false otherwise.</td></tr></table>
</ul>
<br/>
<hr/>
<h3>setDefault</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setDefault</span> () = 0;<br/></pre>
Reset the value to the default value.<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