630 lines
41 KiB
HTML
630 lines
41 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>ewol Library</h1>
|
|
<div id="menu">
|
|
<h2>ewol</h2>
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a>compositing</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__Compositing.html">Compositing</a></li>
|
|
<li><a href="ewol__compositing__Area.html">Area</a></li>
|
|
<li><a href="ewol__compositing__Drawing.html">Drawing</a></li>
|
|
<li><a href="ewol__compositing__Image.html">Image</a></li>
|
|
<li><a href="ewol__compositing__Shaper.html">Shaper</a></li>
|
|
<li><a href="ewol__compositing__Sprite.html">Sprite</a></li>
|
|
<li><a href="ewol__compositing__Text.html">Text</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>context</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__Context.html">Context</a></li>
|
|
<li><a href="ewol__context__CommandLine.html">CommandLine</a></li>
|
|
<li><a href="ewol__context__ConfigFont.html">ConfigFont</a></li>
|
|
<li><a href="ewol__context__InputManager.html">InputManager</a></li>
|
|
<li class="sousmenu"><a href="ewol__context__clipBoard.html">clipBoard</a>
|
|
<ul class="niveau3">
|
|
<li><a href="ewol__context__clipBoard.html::clipboardListe">clipboardListe</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="ewol__context__cursorDisplay.html">cursorDisplay</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>event</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__event__Entry.html">Entry</a></li>
|
|
<li><a href="ewol__event__EntrySystem.html">EntrySystem</a></li>
|
|
<li><a href="ewol__event__Input.html">Input</a></li>
|
|
<li><a href="ewol__event__InputSystem.html">InputSystem</a></li>
|
|
<li><a href="ewol__event__Time.html">Time</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>key</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__key__Special.html">Special</a></li>
|
|
<li><a href="ewol__key__keyboard.html">keyboard</a></li>
|
|
<li><a href="ewol__key__status.html">status</a></li>
|
|
<li><a href="ewol__key__type.html">type</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>object</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__Object.html">Object</a></li>
|
|
<li><a href="ewol__object__Config.html">Config</a></li>
|
|
<li><a href="ewol__object__ConfigElement.html">ConfigElement</a></li>
|
|
<li><a href="ewol__object__Manager.html">Manager</a></li>
|
|
<li><a href="ewol__object__Message.html">Message</a></li>
|
|
<li class="sousmenu"><a href="ewol__object__MultiCast.html">MultiCast</a>
|
|
<ul class="niveau3">
|
|
<li><a href="ewol__object__MultiCast.html::MessageList">MessageList</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>openGL</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__openGL__openGlFlags.html">openGlFlags</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>resource</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__Resource.html">Resource</a></li>
|
|
<li><a href="ewol__resource__Colored3DObject.html">Colored3DObject</a></li>
|
|
<li><a href="ewol__resource__ConfigFile.html">ConfigFile</a></li>
|
|
<li><a href="ewol__resource__FontBase.html">FontBase</a></li>
|
|
<li><a href="ewol__resource__FontFreeType.html">FontFreeType</a></li>
|
|
<li><a href="ewol__resource__Manager.html">Manager</a></li>
|
|
<li><a href="ewol__resource__Program.html">Program</a></li>
|
|
<li><a href="ewol__resource__Shader.html">Shader</a></li>
|
|
<li><a href="ewol__resource__Texture.html">Texture</a></li>
|
|
<li><a href="ewol__resource__TextureFile.html">TextureFile</a></li>
|
|
<li><a href="ewol__resource__TexturedFont.html">TexturedFont</a></li>
|
|
<li><a href="ewol__resource__VirtualBufferObject.html">VirtualBufferObject</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a>widget</a>
|
|
<ul class="niveau2">
|
|
<li><a href="ewol__Widget.html">Widget</a></li>
|
|
<li><a href="ewol__widget__Button.html">Button</a></li>
|
|
<li><a href="ewol__widget__ButtonColor.html">ButtonColor</a></li>
|
|
<li><a href="ewol__widget__CheckBox.html">CheckBox</a></li>
|
|
<li><a href="ewol__widget__ColorBar.html">ColorBar</a></li>
|
|
<li><a href="ewol__widget__ColorChooser.html">ColorChooser</a></li>
|
|
<li><a href="ewol__widget__Composer.html">Composer</a></li>
|
|
<li><a href="ewol__widget__Container.html">Container</a></li>
|
|
<li><a href="ewol__widget__ContainerN.html">ContainerN</a></li>
|
|
<li><a href="ewol__widget__ContextMenu.html">ContextMenu</a></li>
|
|
<li><a href="ewol__widget__Entry.html">Entry</a></li>
|
|
<li><a href="ewol__widget__FileChooser.html">FileChooser</a></li>
|
|
<li class="sousmenu"><a href="ewol__widget__Gird.html">Gird</a>
|
|
<ul class="niveau3">
|
|
<li><a href="ewol__widget__Gird.html::GirdProperties">GirdProperties</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="ewol__widget__Image.html">Image</a></li>
|
|
<li><a href="ewol__widget__Joystick.html">Joystick</a></li>
|
|
<li><a href="ewol__widget__Label.html">Label</a></li>
|
|
<li><a href="ewol__widget__Layer.html">Layer</a></li>
|
|
<li><a href="ewol__widget__List.html">List</a></li>
|
|
<li><a href="ewol__widget__ListFileSystem.html">ListFileSystem</a></li>
|
|
<li><a href="ewol__widget__Manager.html">Manager</a></li>
|
|
<li><a href="ewol__widget__Menu.html">Menu</a></li>
|
|
<li><a href="ewol__widget__MenuElement.html">MenuElement</a></li>
|
|
<li><a href="ewol__widget__Parameter.html">Parameter</a></li>
|
|
<li><a href="ewol__widget__ParameterList.html">ParameterList</a></li>
|
|
<li><a href="ewol__widget__PopUp.html">PopUp</a></li>
|
|
<li><a href="ewol__widget__ProgressBar.html">ProgressBar</a></li>
|
|
<li><a href="ewol__widget__Scroll.html">Scroll</a></li>
|
|
<li><a href="ewol__widget__Sizer.html">Sizer</a></li>
|
|
<li><a href="ewol__widget__Slider.html">Slider</a></li>
|
|
<li><a href="ewol__widget__Spacer.html">Spacer</a></li>
|
|
<li><a href="ewol__widget__StdPopUp.html">StdPopUp</a></li>
|
|
<li><a href="ewol__widget__WSlider.html">WSlider</a></li>
|
|
<li><a href="ewol__widget__WidgetScrooled.html">WidgetScrooled</a></li>
|
|
<li><a href="ewol__widget__Windows.html">Windows</a></li>
|
|
<li><a href="ewol__widget__elementPL.html">elementPL</a></li>
|
|
</ul>
|
|
</li>
|
|
<ul>
|
|
<h3> </h3>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: ewol::Object</h1>
|
|
<br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Object">Object</a> (<span class="code-type">void</span>);<br>+ <a class="code-function" href="#Object">Object</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);<br>+ ~<a class="code-function" href="#Object">Object</a> (<span class="code-type">void</span>);<br></pre>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <span class="code-type">void</span> <a class="code-function" href="#removeObject">removeObject</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-storage-keyword">const</span> <a class="code-function" href="#getObjectType">getObjectType</a> (<span class="code-type">void</span>);<br>+ <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <a class="code-function" href="#getTypeDescription">getTypeDescription</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#isTypeCompatible">isTypeCompatible</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_type</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getStatic">getStatic</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#getId">getId</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#registerOnEvent">registerOnEvent</a> (<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_destinationObject</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventId</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventIdgenerated</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_overloadData</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#unRegisterOnEvent">unRegisterOnEvent</a> (<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_destinationObject</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventId</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onObjectRemove">onObjectRemove</a> (<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_removeObject</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onReceiveMessage">onReceiveMessage</a> (<span class="code-storage-keyword">const</span> <a href="ewol__object__Message.html" class="code-type">ewol::object::Message</a> & <span class="code-argument">_msg</span>);<br>+ <span class="code-storage-keyword">const</span> std::vector<ewol::object::ConfigElement> & <a class="code-function" href="#getConfigList">getConfigList</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#setConfig">setConfig</a> (<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#setConfig">setConfig</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#setConfigNamed">setConfigNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_objectName</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#setConfigNamed">setConfigNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_objectName</span>,<br/> <span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br>+ <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <a class="code-function" href="#getConfig">getConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>);<br>+ <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <a class="code-function" href="#getConfig">getConfig</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <a class="code-function" href="#getName">getName</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setName">setName</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#loadXML">loadXML</a> (<a href="http://HeeroYui.github.io/exml//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#storeXML">storeXML</a> (<a href="http://HeeroYui.github.io/exml//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);<br>+ <a href="ewol__object__Manager.html" class="code-type">ewol::object::Manager</a> & <a class="code-function" href="#getObjectManager">getObjectManager</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__object__MultiCast.html" class="code-type">ewol::object::MultiCast</a> & <a class="code-function" href="#getMultiCast">getMultiCast</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__Context.html" class="code-type">ewol::Context</a> & <a class="code-function" href="#getContext">getContext</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setStatusResource">setStatusResource</a> (<span class="code-type">bool</span> <span class="code-argument">_val</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getStatusResource">getStatusResource</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#autoDestroy">autoDestroy</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#addObjectType">addObjectType</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_type</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#addEventId">addEventId</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#generateEventId">generateEventId</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#sendMultiCast">sendMultiCast</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-storage-keyword">const</span> <span class="code-argument">_messageId</span>,<br/> <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#registerMultiCast">registerMultiCast</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-storage-keyword">const</span> <span class="code-argument">_messageId</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#registerConfig">registerConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_type</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_control</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_description</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_default</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#onSetConfig">onSetConfig</a> (<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#onGetConfig">onGetConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>,<br/> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_result</span>);<br></pre>
|
|
|
|
|
|
<h2>Object Hierarchy:</h2>
|
|
<pre>
|
|
<b>ewol::Object</b>
|
|
+--> <a href="ewol__Widget.html">ewol::Widget</a>
|
|
+--> <a href="ewol__Resource.html">ewol::Resource</a>
|
|
</pre>
|
|
<br/>
|
|
<h2>Description:</h2>
|
|
//!< sometimes the user prefer to receive some specific data on an event (instead of the one sed by the widget)/**
|
|
* @brief Basic message classes for ewol system
|
|
* this class mermit at every Object to communicate between them.
|
|
*/<h2>Detail:<h2>
|
|
<h3>ewol::<a id="Object">Object</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Object</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Constructor.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3>ewol::<a id="Object">Object</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Object</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
Constructor.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_name</span> Name of the Object.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>ewol::~<a id="Object">Object</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">Object</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Destructor
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="removeObject">removeObject</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">removeObject</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Asynchronous removing the object
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getObjectType">getObjectType</a> ()</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-function">getObjectType</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the current Object type of the Object
|
|
<br/><ul>
|
|
<b>Return:</b> the last type name of the element
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getTypeDescription">getTypeDescription</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-function">getTypeDescription</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the herarchie of the Object type.
|
|
<br/><ul>
|
|
<b>Return:</b> descriptive string.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="isTypeCompatible">isTypeCompatible</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">isTypeCompatible</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_type</span>);</pre>
|
|
<br/>
|
|
check if the element herited from a specific type
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_type</span> Type to check.
|
|
<br/><b>Return:</b> true if the element is compatible.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getStatic">getStatic</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getStatic</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the static status of the Object == > mark at true if the user set the object mark as static allocated element ==> not auto remove element
|
|
<br/><ul>
|
|
<b>Return:</b> true if it might not be removed == > usefull for conficuration class
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getId">getId</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int32_t</span> <span class="code-function">getId</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the UniqueId of the Object
|
|
<br/><ul>
|
|
<b>Return:</b> the requested ID
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="registerOnEvent">registerOnEvent</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">registerOnEvent</span>(<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_destinationObject</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventId</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventIdgenerated</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_overloadData</span>);</pre>
|
|
<br/>
|
|
Register an Object over an other to get event on the second...
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_destinationObject</span> pointer on the object that might be call when an event is generated
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_eventId</span> Event generate inside the object
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_eventIdgenerated</span> event generated when call the distant Object.onReceiveMessage(...)
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_overloadData</span> When the user prever to receive a data specificly for this event ...
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="unRegisterOnEvent">unRegisterOnEvent</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">unRegisterOnEvent</span>(<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_destinationObject</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_eventId</span>);</pre>
|
|
<br/>
|
|
Un-Register an Object over an other.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_destinationObject</span> pointer on the object that might be call when an event is generated
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_eventId</span> Event generate inside the object (NULL to remove all event on this object)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onObjectRemove">onObjectRemove</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onObjectRemove</span>(<a href="ewol__Object.html" class="code-type">ewol::Object</a> * <span class="code-argument">_removeObject</span>);</pre>
|
|
<br/>
|
|
Inform object that an other object is removed ...
|
|
<br/><b>Notes:</b> : Sub classes must call this class
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_removObject</span> Pointer on the Object remeved == > the user must remove all reference on this Object
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onReceiveMessage">onReceiveMessage</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onReceiveMessage</span>(<span class="code-storage-keyword">const</span> <a href="ewol__object__Message.html" class="code-type">ewol::object::Message</a> & <span class="code-argument">_msg</span>);</pre>
|
|
<br/>
|
|
Receive a message from an other Object with a specific eventId and data
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_msg</span> Message handle
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getConfigList">getConfigList</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> std::vector<ewol::object::ConfigElement> & <span class="code-function">getConfigList</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get all the configuration list
|
|
<br/><ul>
|
|
<b>Return:</b> The list of all parameter availlable in the widget
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setConfig">setConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">setConfig</span>(<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);</pre>
|
|
<br/>
|
|
Configuration requested to the curent Object (systrem mode)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_conf</span> Configuration handle.
|
|
<br/><b>Return:</b> true if config set correctly...
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setConfig">setConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">setConfig</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setConfigNamed">setConfigNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">setConfigNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_objectName</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setConfigNamed">setConfigNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">setConfigNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_objectName</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getConfig">getConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-function">getConfig</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>);</pre>
|
|
<br/>
|
|
Configuration get from the curent Object (systrem mode)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_config</span> Configuration name.
|
|
<br/><b>Return:</b> the config properties
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getConfig">getConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-function">getConfig</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_config</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getName">getName</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-function">getName</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the Object name
|
|
<br/><ul>
|
|
<b>Return:</b> The requested name
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setName">setName</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setName</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
get the Widget name
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_name</span> The new name
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="loadXML">loadXML</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">loadXML</span>(<a href="http://HeeroYui.github.io/exml//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);</pre>
|
|
<br/>
|
|
load properties with an XML node.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_node</span> Pointer on the tinyXML node.
|
|
<br/><b>Return:</b> true : All has been done corectly.
|
|
<br/><b>Return:</b> false : An error occured.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="storeXML">storeXML</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">storeXML</span>(<a href="http://HeeroYui.github.io/exml//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);</pre>
|
|
<br/>
|
|
store properties in this XML node.
|
|
<br/><ul>
|
|
<b>Parameter [input] [output]:</b> <span class="code-argument">_node</span> Pointer on the tinyXML node.
|
|
<br/><b>Return:</b> true : All has been done corectly.
|
|
<br/><b>Return:</b> false : An error occured.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getObjectManager">getObjectManager</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__object__Manager.html" class="code-type">ewol::object::Manager</a> & <span class="code-function">getObjectManager</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<ul>
|
|
<b>Return:</b> the requested object manager.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getMultiCast">getMultiCast</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__object__MultiCast.html" class="code-type">ewol::object::MultiCast</a> & <span class="code-function">getMultiCast</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<ul>
|
|
<b>Return:</b> the requested object manager.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getContext">getContext</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__Context.html" class="code-type">ewol::Context</a> & <span class="code-function">getContext</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent the system inteface.
|
|
<br/><ul>
|
|
<b>Return:</b> current reference on the instance.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setStatusResource">setStatusResource</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setStatusResource</span>(<span class="code-type">bool</span> <span class="code-argument">_val</span>);</pre>
|
|
<br/>
|
|
Declare this element as a resource (or singleton) this mean the element will
|
|
not be auto Remove at the end of the programm. It just notify that it is not removed.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_val</span> Value of the type of the element.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getStatusResource">getStatusResource</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getStatusResource</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the resource status of the element.
|
|
<br/><ul>
|
|
<b>Return:</b> the resource status.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="autoDestroy">autoDestroy</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">autoDestroy</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Auto-destroy the object
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="addObjectType">addObjectType</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">addObjectType</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_type</span>);</pre>
|
|
<br/>
|
|
Add a type of the list of Object.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_type</span> new type to add.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="addEventId">addEventId</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">addEventId</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>);</pre>
|
|
<br/>
|
|
add a specific event Id in the list to prevent wrong link on a Object
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_generateEventId</span> event Id to add
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="generateEventId">generateEventId</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">generateEventId</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>);</pre>
|
|
<br/>
|
|
generate event on all registered Object
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_generateEventId</span> event Id that is curetly generated
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_data</span> data associated with the event
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="sendMultiCast">sendMultiCast</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">sendMultiCast</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-storage-keyword">const</span> <span class="code-argument">_messageId</span>,
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>);</pre>
|
|
<br/>
|
|
generate Multicast event on all Object requested the event
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_messageId</span> Event Id that is generated
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_data</span> String that is send at all the destinations
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="registerMultiCast">registerMultiCast</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">registerMultiCast</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-storage-keyword">const</span> <span class="code-argument">_messageId</span>);</pre>
|
|
<br/>
|
|
Register of the arrival of a Multicast message
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_messageId</span> Event Id waiting for...
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="registerConfig">registerConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">registerConfig</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_type</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_control</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_description</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_default</span>);</pre>
|
|
<br/>
|
|
the Object add a configuration capabilities
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_config</span> Configuration name.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_type</span> Type of the config.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_control</span> control of the current type.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_description</span> Descritpion on the current type.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_default</span> Default value of this parameter.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onSetConfig">onSetConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">onSetConfig</span>(<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);</pre>
|
|
<br/>
|
|
Configuration requested to the curent Object
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_conf</span> Configuration handle.
|
|
<br/><b>Return:</b> true if the parametere has been used
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onGetConfig">onGetConfig</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>,
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_result</span>);</pre>
|
|
<br/>
|
|
Receive a configuration message from an other element system or from the curent Object
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_config</span> Configuration name.
|
|
<br/><b>Parameter [output]:</b> <span class="code-argument">_result</span> Result of the request.
|
|
<br/><b>Return:</b> true if the config is set
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|