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

316 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__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::Windows</h1><hr/><h2>enum:</h2>
<ul>
<li><a href="enum_ewol__widget__Windows__popUpMessageType.html">popUpMessageType</a></li></ul>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#3132">Windows</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#3134">~Windows</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-type" >void</span> <a class="code-function" href="#3136">sysDraw</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3138">sysOnShow</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3140">sysOnHide</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3142">sysOnKill</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="#3144">onShow</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="#3146">onHide</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="#3148">onKill</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="#3150">onReduce</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="#3152">on</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3155">setDecorationDisable</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3157">setDecorationEnable</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3161">setSubWidget</a> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3163">popUpWidgetPush</a> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/>+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <a class="code-function" href="#3166">getBackgroundColor</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3168">setBackgroundColor</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <span class="code-argument">_color</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#3170">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="#3172">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" >void</span> <a class="code-function" href="#3174">onObjectRemove</a> (<a class="code-type" href="class_ewol__Object.html">ewol::Object</a>* <span class="code-argument">_removeObject</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#3176">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <a class="code-function" href="#3178">getWidgetAtPos</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3180">setTitle</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">_title</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#3183">createPopUpMessage</a> (<span class="code-storage-keyword">enum</span> popUpMessageType <span class="code-argument">_type</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">_message</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3186">displayInfoMessage</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">_message</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3188">displayWarningMessage</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">_message</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3190">displayErrorMessage</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">_message</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3192">displayCriticalMessage</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">_message</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::Windows<br/></pre>
<h2>Detail:</h2>
<a id="3132"/><a id="3134"/><h3>Windows</h3><pre>
+ <span class="code-function">Windows</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3136"/><h3>~Windows</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Windows</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3138"/><h3>sysDraw</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">sysDraw</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3140"/><h3>sysOnShow</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">sysOnShow</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3142"/><h3>sysOnHide</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">sysOnHide</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3144"/><h3>sysOnKill</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">sysOnKill</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3146"/><h3>onShow</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onShow</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3148"/><h3>onHide</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onHide</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3150"/><h3>onKill</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onKill</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3152"/><h3>onReduce</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onReduce</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3155"/><h3>on</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">on</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3157"/><h3>setDecorationDisable</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setDecorationDisable</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3161"/><h3>setDecorationEnable</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setDecorationEnable</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3163"/><h3>setSubWidget</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setSubWidget</span> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3166"/><h3>popUpWidgetPush</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">popUpWidgetPush</span> (<a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <span class="code-argument">_widget</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3168"/><h3>getBackgroundColor</h3><pre>
+ <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <span class="code-function">getBackgroundColor</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
get the background color.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>A reference on the color</td></tr></table>
</ul>
<br/>
<hr/>
<a id="3170"/><h3>setBackgroundColor</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setBackgroundColor</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <span class="code-argument">_color</span>);<br/></pre>
set the background color.<br/>
<br/>
<hr/>
<a id="3172"/><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="3174"/><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="3176"/><h3>onObjectRemove</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onObjectRemove</span> (<a class="code-type" href="class_ewol__Object.html">ewol::Object</a>* <span class="code-argument">_removeObject</span>);<br/></pre>
Inform object that an other object is removed ...<br/><b>Note:</b> : Sub classes must call this class<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_removObject</span> </td><td> Pointer on the Object remeved == &gt; the user must remove all reference on this Object</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="3178"/><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="3180"/><h3>getWidgetAtPos</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__Widget.html">ewol::Widget</a>* <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>NULL No widget found&lt;br/&gt;pointer on the widget found</td></tr></table>
</ul>
<br/>
<hr/>
<a id="3183"/><h3>setTitle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setTitle</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">_title</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="3186"/><h3>createPopUpMessage</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">createPopUpMessage</span> (<span class="code-storage-keyword">enum</span> popUpMessageType <span class="code-argument">_type</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">_message</span>);<br/></pre>
Create a simple pop-up message on the screen for application error.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of the error.</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> message to display (decorated text)</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="3188"/><h3>displayInfoMessage</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">displayInfoMessage</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">_message</span>);<br/></pre>
Create a simple information message<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> message to display (decorated text)</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="3190"/><h3>displayWarningMessage</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">displayWarningMessage</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">_message</span>);<br/></pre>
Create a simple warning message<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> message to display (decorated text)</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="3192"/><h3>displayErrorMessage</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">displayErrorMessage</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">_message</span>);<br/></pre>
Create a simple error message<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> message to display (decorated text)</td></tr>
</table>
</ul>
<br/>
<hr/>
<h3>displayCriticalMessage</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">displayCriticalMessage</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">_message</span>);<br/></pre>
Create a simple critical message<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> message to display (decorated text)</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