atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/class_ewol__widget__Image.html

323 lines
24 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__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::Image</h1><hr/><h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#2635">Image</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">_file</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#2638">~Image</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2627">eventPressed</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2628">configRatio</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2629">configSize</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2630">configBorder</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#2631">configSource</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2632">init</a> (<a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);<br/># <a class="code-type" href="class_ewol__compositing__Image.html">ewol::compositing::Image</a> <a class="code-member" href="#2634">m_compositing</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2640">set</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">_file</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/># <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <a class="code-member" href="#2643">m_fileName</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2644">setFile</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">_file</span>);<br/>+ <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <a class="code-function" href="#2646">getFile</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/># <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> <a class="code-member" href="#2648">m_border</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2649">setBorder</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/>+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <a class="code-function" href="#2651">getBorder</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/># <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> <a class="code-member" href="#2653">m_imageSize</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2654">setImageSize</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_size</span>);<br/>+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <a class="code-function" href="#2656">getImageSize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/># <span class="code-type" >bool</span> <a class="code-member" href="#2658">m_keepRatio</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2659">setKeepRatio</a> (<span class="code-type" >bool</span> <span class="code-argument">_keep</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#2661">getKeepRatio</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <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="#2663">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" >bool</span> <a class="code-function" href="#2665">onSetConfig</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__Config.html">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2667">onGetConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_result</span>) <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="#2670">calculateMinMaxSize</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="#2672">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="#2674">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/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#2676">loadXML</a> (<a class="code-type" href="class_exml__Element.html">exml::Element</a>* <span class="code-argument">_node</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/> +--> ewol::widget::Image<br/></pre>
<h2>Detail:</h2>
<a id="2627"/><a id="2628"/><h3>eventPressed</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">eventPressed</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2629"/><h3>configRatio</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configRatio</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2630"/><h3>configSize</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configSize</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2631"/><h3>configBorder</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configBorder</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2632"/><h3>configSource</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">configSource</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="2634"/><h3>init</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">init</span> (<a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);<br/></pre>
Main call of recording the widget on the List of "widget named creator"<br/>
<br/>
<hr/>
<a id="2635"/><h3>m_compositing</h3><pre>
# <a class="code-type" href="class_ewol__compositing__Image.html">ewol::compositing::Image</a> <span class="code-member">m_compositing</span>;<br/></pre>
compositing element of the image.<br/>
<br/>
<hr/>
<a id="2638"/><h3>Image</h3><pre>
+ <span class="code-function">Image</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">_file</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/></pre>
<br/>
<hr/>
<a id="2640"/><h3>~Image</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Image</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<hr/>
<a id="2643"/><h3>set</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">set</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">_file</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/></pre>
set All the configuration of the current image<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_file</span> </td><td> Filaneme of the new image</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_border</span> </td><td> New border size to set</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2644"/><h3>m_fileName</h3><pre>
# <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-member">m_fileName</span>;<br/></pre>
file name of the image.<br/>
<br/>
<hr/>
<a id="2646"/><h3>setFile</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setFile</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">_file</span>);<br/></pre>
set the new filename<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_file</span> </td><td> Filaneme of the new image</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2648"/><h3>getFile</h3><pre>
+ <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-function">getFile</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the file displayed<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the filename of the image</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2649"/><h3>m_border</h3><pre>
# <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> <span class="code-member">m_border</span>;<br/></pre>
border to add at the image.<br/>
<br/>
<hr/>
<a id="2651"/><h3>setBorder</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setBorder</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_border</span>);<br/></pre>
set tge Border size around the image<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_border</span> </td><td> New border size to set</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2653"/><h3>getBorder</h3><pre>
+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-function">getBorder</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the current border request at the image<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the border size</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2654"/><h3>m_imageSize</h3><pre>
# <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> <span class="code-member">m_imageSize</span>;<br/></pre>
border to add at the image.<br/>
<br/>
<hr/>
<a id="2656"/><h3>setImageSize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setImageSize</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-argument">_size</span>);<br/></pre>
set tge Border size around the image<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> New border size to set</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2658"/><h3>getImageSize</h3><pre>
+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__Dimension.html">ewol::Dimension</a> & <span class="code-function">getImageSize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the current border request at the image<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the border size</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2659"/><h3>m_keepRatio</h3><pre>
# <span class="code-type" >bool</span> <span class="code-member">m_keepRatio</span>;<br/></pre>
keep the image ratio between width and hight<br/>
<br/>
<hr/>
<a id="2661"/><h3>setKeepRatio</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setKeepRatio</span> (<span class="code-type" >bool</span> <span class="code-argument">_keep</span>);<br/></pre>
set the current status of keeping ratio.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_keep</span> </td><td> The new status of keeping the ratio of this image.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="2663"/><h3>getKeepRatio</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">getKeepRatio</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the current status of keeping ratio.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The status of keeping the ratio of this image.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2665"/><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="2667"/><h3>onSetConfig</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onSetConfig</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__Config.html">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br/></pre>
Configuration requested to the curent Object<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_conf</span> </td><td> Configuration handle.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true if the parametere has been used</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2670"/><h3>onGetConfig</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onGetConfig</span> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_result</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
Receive a configuration message from an other element system or from the curent Object<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_config</span> </td><td> Configuration name.</td></tr>
<td><b>Parameter [output]:</b></td><td><span class="code-argument">_result</span> </td><td> Result of the request.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true if the config is set</td></tr></table>
</ul>
<br/>
<hr/>
<a id="2672"/><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="2674"/><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/>
<a id="2676"/><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/>
<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/>
</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