984 lines
78 KiB
HTML
984 lines
78 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ewol Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ewol library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ewol/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a href="namespace_ewol.html">ewol</a>
|
|
<ul class="niveau2">
|
|
<li><a href="namespace_ewol__translate.html">translate</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__key.html">key</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__widget.html">widget</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__openGL.html">openGL</a>
|
|
</li>
|
|
<li class="sousmenu"><a href="namespace_ewol__context.html">context</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__context__clipBoard.html">clipBoard</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_ewol__compositing.html">compositing</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__object.html">object</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__resource.html">resource</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__font.html">font</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__event.html">event</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_MacOs.html">MacOs</a>
|
|
</li>
|
|
<li><a href="namespace_IOs.html">IOs</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h3>Documentation:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="001_bases.html">Bases</a></li>
|
|
</ul><ul class="niveau1"><li><a href="faq.html">Faq</a></li>
|
|
</ul></div>
|
|
<h3>Tutorials:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_001_HelloWord.html">Hello word</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_010_ObjectModel.html">Object model</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_011_ObjectConfig.html">Object config</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_012_ObjectMessage.html">Object message</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_020_FileAccess.html">File access</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_021_Resources.html">Resources</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_030_ConplexeXmlGui.html">Conplexe xml gui</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_050_CreateCustomWidget.html">Create custom widget</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_051_AddWidgetCustumInXML.html">Add widget custum in x m l</a></li>
|
|
</ul></div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: ewol::Widget</h1><hr/><h2>Description:</h2>
|
|
Widget class is the main widget interface, it hase some generic properties:
|
|
<ul> known his parent
|
|
Can be display at a special position with a special scale
|
|
Can get focus
|
|
</ul>:INDENT: Receive Event (keyboard / mouse / ...)<br/><br/>
|
|
<h2>Associated Namespace:</h2><ul>
|
|
<a href="namespace_ewol__widget.html">widget</a></ul>
|
|
<h2>enum:</h2>
|
|
<ul>
|
|
<li><a href="enum_ewol__Widget__annimationMode.html">annimationMode</a></li></ul>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
# <a class="code-function" href="#937">Widget</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#941">~Widget</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
# <span class="code-type" >void</span> <a class="code-function" href="#938">init</a> ();<br/># <span class="code-type" >void</span> <a class="code-function" href="#939">init</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">_name</span>);<br/># vec2 <a class="code-member" href="#942">m_size</a>;<br/># vec2 <a class="code-member" href="#943">m_minSize</a>;<br/># vec2 <a class="code-member" href="#944">m_maxSize</a>;<br/>+ <span class="code-storage-keyword">virtual</span> vec2 <a class="code-function" href="#945">relativePosition</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#947">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_available</span>);<br/>+ <span class="code-storage-keyword">virtual</span> vec2 <a class="code-function" href="#949">getSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#950">calculateMinMaxSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> vec2 <a class="code-function" href="#951">getCalculateMinSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> vec2 <a class="code-function" href="#952">getCalculateMaxSize</a> ();<br/># vec2 <a class="code-member" href="#953">m_offset</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#954">setOffset</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newVal</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> vec2 & <a class="code-function" href="#956">getOffset</a> ();<br/># <span class="code-type" >float</span> <a class="code-member" href="#957">m_zoom</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#958">setZoom</a> (<span class="code-type" >float</span> <span class="code-argument">_newVal</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <a class="code-function" href="#960">getZoom</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#961">changeZoom</a> (<span class="code-type" >float</span> <span class="code-argument">_range</span>);<br/># vec2 <a class="code-member" href="#963">m_origin</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#964">setOrigin</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> vec2 <a class="code-function" href="#966">getOrigin</a> ();<br/># <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><ewol::Dimension> <a class="code-member" href="#967">m_userMinSize</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#968">setMinSize</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-type" >void</span> <a class="code-function" href="#970">setNoMinSize</a> ();<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="#971">getMinSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#972">checkMinSize</a> ();<br/># <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><ewol::Dimension> <a class="code-member" href="#973">m_userMaxSize</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#974">setMaxSize</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-type" >void</span> <a class="code-function" href="#976">setNoMaxSize</a> ();<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="#977">getMaxSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#978">checkMaxSize</a> ();<br/># <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bvec2> <a class="code-member" href="#979">m_userExpand</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#980">setExpand</a> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newExpand</span>);<br/>+ <span class="code-storage-keyword">virtual</span> bvec2 <a class="code-function" href="#982">getExpand</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> bvec2 <a class="code-function" href="#983">canExpand</a> ();<br/># <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bvec2> <a class="code-member" href="#984">m_userFill</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#985">setFill</a> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newFill</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> bvec2 & <a class="code-function" href="#987">getFill</a> ();<br/>+ <span class="code-storage-keyword">const</span> bvec2 & <a class="code-function" href="#988">canFill</a> ();<br/># <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bool> <a class="code-member" href="#989">m_hide</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#990">hide</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#991">show</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#992">isHide</a> ();<br/># <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><enumewol::gravity> <a class="code-member" href="#993">m_gravity</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#994">setGravity</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__gravity.html">ewol::gravity</a> <span class="code-argument">_gravity</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__gravity.html">ewol::gravity</a> <a class="code-function" href="#996">getGravity</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#999">getFocus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1000">canHaveFocus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1001">setFocus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1002">rmFocus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1003">setCanHaveFocus</a> (<span class="code-type" >bool</span> <span class="code-argument">_canFocusState</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1005">keepFocus</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1006">onGetFocus</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1007">onLostFocus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >int32_t</span> <a class="code-function" href="#1009">getMouseLimit</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1010">setMouseLimit</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_numberState</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1013">getKeyboardRepeate</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1014">setKeyboardRepeate</a> (<span class="code-type" >bool</span> <span class="code-argument">_state</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1016">showKeyboard</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1017">hideKeyboard</a> ();<br/># <span class="code-type" >void</span> <a class="code-function" href="#1020">periodicCallDisable</a> ();<br/># <span class="code-type" >void</span> <a class="code-function" href="#1021">periodicCallEnable</a> (<span class="code-type" >float</span> <span class="code-argument">_callInSecond</span>);<br/>+ <span class="code-type" >int64_t</span> <a class="code-function" href="#1023">systemGetCallDeltaTime</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >int64_t</span> <a class="code-function" href="#1024">systemGetLastCallTime</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1025">systemSetLastCallTime</a> (<span class="code-type" >int64_t</span> <span class="code-argument">_time</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1027">periodicCall</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::Widget> <a class="code-function" href="#1029">getWidgetAtPos</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1031">systemEventInput</a> (<a class="code-type" href="class_ewol__event__InputSystem.html">ewol::event::InputSystem</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="#1033">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="#1035">systemEventEntry</a> (<a class="code-type" href="class_ewol__event__EntrySystem.html">ewol::event::EntrySystem</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="#1037">onEventEntry</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Entry.html">ewol::event::Entry</a> & <span class="code-argument">_event</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1039">onEventClipboard</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><std::string> <a class="code-member" href="#1041">signalShortcut</a>;<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1043">shortCutAdd</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">_descriptiveString</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-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1046">shortCutClean</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1047">shortCutRemove</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-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1049">onEventShortCut</a> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <span class="code-type" >char32_t</span> <span class="code-argument">_unicodeValue</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__keyboard.html">ewol::key::keyboard</a> <span class="code-argument">_kbMove</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>);<br/># <span class="code-type" >bool</span> <a class="code-member" href="#1054">m_needRegenerateDisplay</a>;<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1055">markToRedraw</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1056">needRedraw</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1057">systemDraw</a> (<span class="code-storage-keyword">const</span> DrawProperty & <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="#1059">onDraw</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1060">onRegenerateDisplay</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1062">grabCursor</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1063">unGrabCursor</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1064">getGrabStatus</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1065">setCursor</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <span class="code-argument">_newCursor</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <a class="code-function" href="#1067">getCursor</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1068">loadXML</a> (<a class="code-type" href="class_exml__Element.html">exml::Element</a>* <span class="code-argument">_node</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1070">onParameterChangeValue</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__ParameterRef.html">ewol::object::ParameterRef</a> & <span class="code-argument">_paramPointer</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1072">requestUpdateSize</a> ();<br/>+ <a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <a class="code-function" href="#1073">getWidgetManager</a> ();<br/>+ <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::widget::Windows> <a class="code-function" href="#1074">getWindows</a> ();<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <a class="code-member" href="#1075">signalAnnimationStart</a>;<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><float> <a class="code-member" href="#1076">signalAnnimationRatio</a>;<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <a class="code-member" href="#1077">signalAnnimationStop</a>;<br/># <span class="code-type" >float</span> <a class="code-member" href="#1079">m_annimationratio</a>;<br/># <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><int32_t> <a class="code-member" href="#1080">m_annimationTypeStart</a>;<br/># <a class="code-type" href="class_ewol__object__ParamRange.html">ewol::object::ParamRange</a><float> <a class="code-member" href="#1081">m_annimationTimeStart</a>;<br/># <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><int32_t> <a class="code-member" href="#1082">m_annimationTypeStop</a>;<br/># <a class="code-type" href="class_ewol__object__ParamRange.html">ewol::object::ParamRange</a><float> <a class="code-member" href="#1083">m_annimationTimeStop</a>;<br/># <span class="code-type" >void</span> <a class="code-function" href="#1084">addAnnimationType</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</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-type" >void</span> <a class="code-function" href="#1087">setAnnimationType</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</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">_type</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#1090">setAnnimationTime</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_time</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#1093">startAnnimation</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#1095">stopAnnimation</a> ();<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#1096">onStartAnnimation</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#1098">onStopAnnimation</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+std::enable_shared_from_this<Object><br/>+<a href="class_ewol__object__ParameterList.html">ewol::object::ParameterList</a><br/>+<a href="class_ewol__object__SignalList.html">ewol::object::SignalList</a><br/> +--> +<a href="class_ewol__Object.html">ewol::Object</a><br/> +--> ewol::Widget<br/> +--> <a href="class_ewol__widget__ButtonColor.html">ewol::widget::ButtonColor</a><br/> +--> <a href="class_ewol__widget__WidgetScrolled.html">ewol::widget::WidgetScrolled</a><br/> +--> <a href="class_ewol__widget__Joystick.html">ewol::widget::Joystick</a><br/> +--> <a href="class_ewol__widget__Slider.html">ewol::widget::Slider</a><br/> +--> <a href="class_ewol__widget__Spacer.html">ewol::widget::Spacer</a><br/> +--> <a href="class_ewol__widget__Label.html">ewol::widget::Label</a><br/> +--> <a href="class_ewol__widget__Container2.html">ewol::widget::Container2</a><br/> +--> <a href="class_ewol__widget__Image.html">ewol::widget::Image</a><br/> +--> <a href="class_ewol__widget__ProgressBar.html">ewol::widget::ProgressBar</a><br/> +--> <a href="class_ewol__widget__Windows.html">ewol::widget::Windows</a><br/> +--> <a href="class_ewol__widget__Container.html">ewol::widget::Container</a><br/> +--> <a href="class_ewol__widget__ContainerN.html">ewol::widget::ContainerN</a><br/> +--> <a href="class_ewol__widget__Gird.html">ewol::widget::Gird</a><br/> +--> <a href="class_ewol__widget__Entry.html">ewol::widget::Entry</a><br/> +--> <a href="class_ewol__widget__ColorBar.html">ewol::widget::ColorBar</a><br/> +--> <a href="../ege/class_ege__widget__Mesh.html">ege::widget::Mesh</a><br/> +--> <a href="../ege/class_ege__widget__Scene.html">ege::widget::Scene</a><br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="937"/><a id="938"/><h3>Widget</h3><pre>
|
|
# <span class="code-function">Widget</span> ();<br/></pre>
|
|
Constructor of the widget classes<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>(no execption generated (not managed in embended platform))</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="939"/><h3>init</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">init</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="941"/><h3>init</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">init</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">_name</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="942"/><h3>~Widget</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Widget</span> ();<br/></pre>
|
|
Destructor of the widget classes<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="943"/><h3>m_size</h3><pre>
|
|
# vec2 <span class="code-member">m_size</span>;<br/></pre>
|
|
|
|
internal : current size of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="944"/><h3>m_minSize</h3><pre>
|
|
# vec2 <span class="code-member">m_minSize</span>;<br/></pre>
|
|
|
|
internal : minimum size of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="945"/><h3>m_maxSize</h3><pre>
|
|
# vec2 <span class="code-member">m_maxSize</span>;<br/></pre>
|
|
|
|
internal : maximum size of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="947"/><h3>relativePosition</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec2 <span class="code-function">relativePosition</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
convert the absolute position in the local Position (Relative)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_pos</span> </td><td> Absolute position that you request convertion</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>the relative position</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="949"/><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">_available</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="950"/><h3>getSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec2 <span class="code-function">getSize</span> ();<br/></pre>
|
|
get the widget size<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Requested size</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="951"/><h3>calculateMinMaxSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateMinMaxSize</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="952"/><h3>getCalculateMinSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec2 <span class="code-function">getCalculateMinSize</span> ();<br/></pre>
|
|
get the widget minimum size calculated<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Requested size</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="953"/><h3>getCalculateMaxSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec2 <span class="code-function">getCalculateMaxSize</span> ();<br/></pre>
|
|
get the widget maximum size calculated<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Requested size</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="954"/><h3>m_offset</h3><pre>
|
|
# vec2 <span class="code-member">m_offset</span>;<br/></pre>
|
|
|
|
Offset of the display in the viewport<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="956"/><h3>setOffset</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setOffset</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newVal</span>);<br/></pre>
|
|
set the zoom property of the widget.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newVal</span> </td><td> offset value.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="957"/><h3>getOffset</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> vec2 & <span class="code-function">getOffset</span> ();<br/></pre>
|
|
get the offset property of the widget.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The current offset value.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="958"/><h3>m_zoom</h3><pre>
|
|
# <span class="code-type" >float</span> <span class="code-member">m_zoom</span>;<br/></pre>
|
|
|
|
generic widget zoom<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="960"/><h3>setZoom</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setZoom</span> (<span class="code-type" >float</span> <span class="code-argument">_newVal</span>);<br/></pre>
|
|
set the zoom property of the widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newVal</span> </td><td> newZoom value</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="961"/><h3>getZoom</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <span class="code-function">getZoom</span> ();<br/></pre>
|
|
get the zoom property of the widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the current zoom value</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="963"/><h3>changeZoom</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">changeZoom</span> (<span class="code-type" >float</span> <span class="code-argument">_range</span>);<br/></pre>
|
|
Change Zoom property.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_range</span> </td><td> Range of the zoom change.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="964"/><h3>m_origin</h3><pre>
|
|
# vec2 <span class="code-member">m_origin</span>;<br/></pre>
|
|
|
|
internal ... I do not really known how i can use it ...<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="966"/><h3>setOrigin</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setOrigin</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
set origin at the widget (must be an parrent widget that set this parameter).
|
|
This represent the absolute origin in the program windows<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> Position of the origin</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="967"/><h3>getOrigin</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec2 <span class="code-function">getOrigin</span> ();<br/></pre>
|
|
get the origin (obsolute position in the windows)<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>coordonate of the origin requested</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="968"/><h3>m_userMinSize</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><ewol::Dimension> <span class="code-member">m_userMinSize</span>;<br/></pre>
|
|
|
|
user define the minimum size of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="970"/><h3>setMinSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setMinSize</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>
|
|
User set the minimum size he want to set the display<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> set minimum size (none : 0)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="971"/><h3>setNoMinSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setNoMinSize</span> ();<br/></pre>
|
|
User set No minimum size.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="972"/><h3>getMinSize</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">getMinSize</span> ();<br/></pre>
|
|
get the current calculated min size<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the size requested</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="973"/><h3>checkMinSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">checkMinSize</span> ();<br/></pre>
|
|
Check if the current min size is compatible with the user minimum size
|
|
If it is not the user minimum size will overWrite the minimum size set.<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="974"/><h3>m_userMaxSize</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><ewol::Dimension> <span class="code-member">m_userMaxSize</span>;<br/></pre>
|
|
|
|
user define the maximum size of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="976"/><h3>setMaxSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setMaxSize</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>
|
|
User set the maximum size he want to set the display<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> The new maximum size requested (vec2(0,0) to unset)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="977"/><h3>setNoMaxSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setNoMaxSize</span> ();<br/></pre>
|
|
User set No maximum size.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="978"/><h3>getMaxSize</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">getMaxSize</span> ();<br/></pre>
|
|
get the current maximum size<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the size requested</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="979"/><h3>checkMaxSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">checkMaxSize</span> ();<br/></pre>
|
|
Check if the current max size is compatible with the user maximum size
|
|
If it is not the user maximum size will overWrite the maximum size set.<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="980"/><h3>m_userExpand</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bvec2> <span class="code-member">m_userExpand</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="982"/><h3>setExpand</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setExpand</span> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newExpand</span>);<br/></pre>
|
|
set the expend capabilities (x&y)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newExpend</span> </td><td> 2D boolean repensent the capacity to expend</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="983"/><h3>getExpand</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> bvec2 <span class="code-function">getExpand</span> ();<br/></pre>
|
|
get the expend capabilities (x&y) (set by the user)<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>2D boolean repensent the capacity to expend</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="984"/><h3>canExpand</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> bvec2 <span class="code-function">canExpand</span> ();<br/></pre>
|
|
get the expend capabilities (x&y)<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>2D boolean repensent the capacity to expend</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="985"/><h3>m_userFill</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bvec2> <span class="code-member">m_userFill</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="987"/><h3>setFill</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setFill</span> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newFill</span>);<br/></pre>
|
|
set the x&y filling capacity<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newFill</span> </td><td> new x&y fill state</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="988"/><h3>getFill</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> bvec2 & <span class="code-function">getFill</span> ();<br/></pre>
|
|
set the x&y filling capacity set by the user<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>bvec2 repensent the capacity to x&y filling (set by the user)</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="989"/><h3>canFill</h3><pre>
|
|
+ <span class="code-storage-keyword">const</span> bvec2 & <span class="code-function">canFill</span> ();<br/></pre>
|
|
get the filling capabilities x&y<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>bvec2 repensent the capacity to x&y filling</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="990"/><h3>m_hide</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__Param.html">ewol::object::Param</a><bool> <span class="code-member">m_hide</span>;<br/></pre>
|
|
|
|
hide a widget on the display<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="991"/><h3>hide</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">hide</span> ();<br/></pre>
|
|
set the widget hidden<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="992"/><h3>show</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">show</span> ();<br/></pre>
|
|
set the widget visible<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="993"/><h3>isHide</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">isHide</span> ();<br/></pre>
|
|
get the visibility of the widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true: if the widget is hiden, false: it is visible</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="994"/><h3>m_gravity</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><enumewol::gravity> <span class="code-member">m_gravity</span>;<br/></pre>
|
|
|
|
Gravity of the widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="996"/><h3>setGravity</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setGravity</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__gravity.html">ewol::gravity</a> <span class="code-argument">_gravity</span>);<br/></pre>
|
|
set the widget gravity<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_gravity</span> </td><td> New gravity of the widget</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="999"/><h3>getGravity</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__gravity.html">ewol::gravity</a> <span class="code-function">getGravity</span> ();<br/></pre>
|
|
get the widget gravity<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the gravity type</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1000"/><h3>getFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">getFocus</span> ();<br/></pre>
|
|
get the focus state of the widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>focus state</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1001"/><h3>canHaveFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">canHaveFocus</span> ();<br/></pre>
|
|
get the capability to have focus<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>State capability to have focus</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1002"/><h3>setFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">setFocus</span> ();<br/></pre>
|
|
set focus on this widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>return true if the widget keep the focus</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1003"/><h3>rmFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">rmFocus</span> ();<br/></pre>
|
|
remove the focus on this widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>return true if the widget have release his focus (if he has it)</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1005"/><h3>setCanHaveFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setCanHaveFocus</span> (<span class="code-type" >bool</span> <span class="code-argument">_canFocusState</span>);<br/></pre>
|
|
set the capability to have the focus<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_canFocusState</span> </td><td> new focus capability</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1006"/><h3>keepFocus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">keepFocus</span> ();<br/></pre>
|
|
keep the focus on this widget == > this remove the previous focus on all other widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1007"/><h3>onGetFocus</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onGetFocus</span> ();<br/></pre>
|
|
Event of the focus has been grep by the current widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1009"/><h3>onLostFocus</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onLostFocus</span> ();<br/></pre>
|
|
Event of the focus has been lost by the current widget<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1010"/><h3>getMouseLimit</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >int32_t</span> <span class="code-function">getMouseLimit</span> ();<br/></pre>
|
|
get the number of mouse event supported<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>return the number of event that the mouse supported [0..3]</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1013"/><h3>setMouseLimit</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setMouseLimit</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_numberState</span>);<br/></pre>
|
|
get the number of mouse event supported<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_numberState</span> </td><td> The number of event that the mouse supported [0..3]</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1014"/><h3>getKeyboardRepeate</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">getKeyboardRepeate</span> ();<br/></pre>
|
|
get the keyboard repeating event supporting.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true : the event can be repeated.<br/>false : the event must not be repeated.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1016"/><h3>setKeyboardRepeate</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setKeyboardRepeate</span> (<span class="code-type" >bool</span> <span class="code-argument">_state</span>);<br/></pre>
|
|
set the keyboard repeating event supporting.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_state</span> </td><td> The repeating status (true: enable, false disable).</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1017"/><h3>showKeyboard</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">showKeyboard</span> ();<br/></pre>
|
|
display the virtual keyboard (if needed)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1020"/><h3>hideKeyboard</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">hideKeyboard</span> ();<br/></pre>
|
|
Hide the virtual keyboard (if needed)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1021"/><h3>periodicCallDisable</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">periodicCallDisable</span> ();<br/></pre>
|
|
disable the periodic call.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1023"/><h3>periodicCallEnable</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">periodicCallEnable</span> (<span class="code-type" >float</span> <span class="code-argument">_callInSecond</span>);<br/></pre>
|
|
disable the periodic call.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_callInSecond</span> </td><td> periodic call in second (float)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1024"/><h3>systemGetCallDeltaTime</h3><pre>
|
|
+ <span class="code-type" >int64_t</span> <span class="code-function">systemGetCallDeltaTime</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
{SYSTEM} get a reference of the periodic call delta time<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the perodic time delta call -1 : disable / 0 : every time / else in US</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1025"/><h3>systemGetLastCallTime</h3><pre>
|
|
+ <span class="code-type" >int64_t</span> <span class="code-function">systemGetLastCallTime</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
{SYSTEM} get a reference of the periodic call time<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Last call from the periodic call</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1027"/><h3>systemSetLastCallTime</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">systemSetLastCallTime</span> (<span class="code-type" >int64_t</span> <span class="code-argument">_time</span>);<br/></pre>
|
|
{SYSTEM} get a reference of the periodic call time<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Last call from the periodic call</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1029"/><h3>periodicCall</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">periodicCall</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
periodic call of this widget<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter:</b></td><td><span class="code-argument">_event</span> </td><td> Current time property</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1031"/><h3>getWidgetAtPos</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::Widget> <span class="code-function">getWidgetAtPos</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br/></pre>
|
|
get the widget at the specific windows absolute position<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_pos</span> </td><td> gAbsolute position of the requested widget knowledge</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>nullptr No widget found<br/>pointer on the widget found</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1033"/><h3>systemEventInput</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">systemEventInput</span> (<a class="code-type" href="class_ewol__event__InputSystem.html">ewol::event::InputSystem</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
{SYSTEM} system event input (only meta widget might overwrite this function).<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<br/>false the event is not used</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1035"/><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<br/>false the event is not used</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1037"/><h3>systemEventEntry</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">systemEventEntry</span> (<a class="code-type" href="class_ewol__event__EntrySystem.html">ewol::event::EntrySystem</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
{SYSTEM} Entry event (only meta widget might overwrite this function).<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 if the event has been used<br/>false if the event has not been used</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1039"/><h3>onEventEntry</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onEventEntry</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Entry.html">ewol::event::Entry</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
Entry event.
|
|
represent the physical event :
|
|
- Keyboard (key event and move event)
|
|
- Accelerometer
|
|
- Joystick<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 if the event has been used<br/>false if the event has not been used</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1041"/><h3>onEventClipboard</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onEventClipboard</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__clipBoard__clipboardListe.html">ewol::context::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br/></pre>
|
|
Event on a past event == > this event is asynchronous due to all system does not support direct getting datas<br/><b>Note:</b> : need to have focus ...<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">mode</span> </td><td> Mode of data requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1043"/><h3>signalShortcut</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><std::string> <span class="code-member">signalShortcut</span>;<br/></pre>
|
|
|
|
signal handle of the message<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1046"/><h3>shortCutAdd</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">shortCutAdd</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">_descriptiveString</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>
|
|
add a specific shortcut with his description<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_descriptiveString</span> </td><td> Description string of the shortcut</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> massage to generate (or shortcut name)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1047"/><h3>shortCutClean</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">shortCutClean</span> ();<br/></pre>
|
|
remove all curent shortCut<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1049"/><h3>shortCutRemove</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">shortCutRemove</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>
|
|
remove a specific shortCut whith his event name<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_message</span> </td><td> renerated event name</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1054"/><h3>onEventShortCut</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onEventShortCut</span> (<a class="code-type" href="class_ewol__key__Special.html">ewol::key::Special</a> & <span class="code-argument">_special</span>,<br/> <span class="code-type" >char32_t</span> <span class="code-argument">_unicodeValue</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__key__keyboard.html">ewol::key::keyboard</a> <span class="code-argument">_kbMove</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_isDown</span>);<br/></pre>
|
|
Event on a short-cut of this Widget (in case of return false, the event on the keyevent will arrive in the function @ref onEventKb).<br/><b>Note:</b> To prevent some error when you get an event get it if it is down and Up ... == > like this it could not generate some ununderstanding error.<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_special</span> </td><td> All the special kay pressed at this time.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_unicodeValue</span> </td><td> Key pressed by the user not used if the kbMove!=ewol::EVENT_KB_MOVE_TYPE_NONE.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_kbMove</span> </td><td> Special key of the keyboard.</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>true if the event has been used.<br/>false if the event has not been used.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1055"/><h3>m_needRegenerateDisplay</h3><pre>
|
|
# <span class="code-type" >bool</span> <span class="code-member">m_needRegenerateDisplay</span>;<br/></pre>
|
|
|
|
the display might be done the next regeneration<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1056"/><h3>markToRedraw</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">markToRedraw</span> ();<br/></pre>
|
|
The widget mark itself that it need to regenerate the nest time.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1057"/><h3>needRedraw</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">needRedraw</span> ();<br/></pre>
|
|
get the need of the redrawing of the widget and reset it to false<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true if we need to redraw<br/>false if we have no need to redraw</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1059"/><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> DrawProperty & <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="1060"/><h3>onDraw</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onDraw</span> ();<br/></pre>
|
|
Common widget drawing function (called by the drawing thread [Android, X11, ...])<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1062"/><h3>onRegenerateDisplay</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onRegenerateDisplay</span> ();<br/></pre>
|
|
Event generated when a redraw is needed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1063"/><h3>grabCursor</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">grabCursor</span> ();<br/></pre>
|
|
Grab the cursor : This get all the mouvement of the mouse in PC mode, and generate an ofset instead of a position.<br/><b>Note:</b> : the generation of the offset is due to the fact the cursor position is forced at the center of the widget.<br/> <b>Note:</b> This done nothing in "Finger" or "Stylet" mode.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1064"/><h3>unGrabCursor</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">unGrabCursor</span> ();<br/></pre>
|
|
Un-Grab the cursor (default mode cursor offset)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1065"/><h3>getGrabStatus</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">getGrabStatus</span> ();<br/></pre>
|
|
get the grabbing status of the cursor.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true if the cursor is curently grabbed</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1067"/><h3>setCursor</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setCursor</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <span class="code-argument">_newCursor</span>);<br/></pre>
|
|
set the cursor display type.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newCursor</span> </td><td> selected new cursor.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1068"/><h3>getCursor</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__context__cursorDisplay.html">ewol::context::cursorDisplay</a> <span class="code-function">getCursor</span> ();<br/></pre>
|
|
get the currrent cursor.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the type of the cursor.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1070"/><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.<br/>false : An error occured.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1072"/><h3>onParameterChangeValue</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onParameterChangeValue</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__object__ParameterRef.html">ewol::object::ParameterRef</a> & <span class="code-argument">_paramPointer</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1073"/><h3>requestUpdateSize</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">requestUpdateSize</span> ();<br/></pre>
|
|
need to be call When the size of the current widget have change == > this force the system to recalculate all the widget positions<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1074"/><h3>getWidgetManager</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__widget__Manager.html">ewol::widget::Manager</a> & <span class="code-function">getWidgetManager</span> ();<br/></pre>
|
|
get the current Widget Manager<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1075"/><h3>getWindows</h3><pre>
|
|
+ <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::widget::Windows> <span class="code-function">getWindows</span> ();<br/></pre>
|
|
get the curent Windows<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1076"/><h3>signalAnnimationStart</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <span class="code-member">signalAnnimationStart</span>;<br/></pre>
|
|
|
|
event when start annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1077"/><h3>signalAnnimationRatio</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><float> <span class="code-member">signalAnnimationRatio</span>;<br/></pre>
|
|
|
|
event when % of annimation change (integer)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1079"/><h3>signalAnnimationStop</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <span class="code-member">signalAnnimationStop</span>;<br/></pre>
|
|
|
|
event when stop annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1080"/><h3>m_annimationratio</h3><pre>
|
|
# <span class="code-type" >float</span> <span class="code-member">m_annimationratio</span>;<br/></pre>
|
|
|
|
Ratio of the annimation [0..1]<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1081"/><h3>m_annimationTypeStart</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><int32_t> <span class="code-member">m_annimationTypeStart</span>;<br/></pre>
|
|
|
|
type of start annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1082"/><h3>m_annimationTimeStart</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__ParamRange.html">ewol::object::ParamRange</a><float> <span class="code-member">m_annimationTimeStart</span>;<br/></pre>
|
|
|
|
time to produce start annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1083"/><h3>m_annimationTypeStop</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__ParamList.html">ewol::object::ParamList</a><int32_t> <span class="code-member">m_annimationTypeStop</span>;<br/></pre>
|
|
|
|
type of start annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1084"/><h3>m_annimationTimeStop</h3><pre>
|
|
# <a class="code-type" href="class_ewol__object__ParamRange.html">ewol::object::ParamRange</a><float> <span class="code-member">m_annimationTimeStop</span>;<br/></pre>
|
|
|
|
time to produce start annimation<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="1087"/><h3>addAnnimationType</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">addAnnimationType</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_type</span>);<br/></pre>
|
|
Add a annimation type capabilities of this widget.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of the annimation.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1090"/><h3>setAnnimationType</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setAnnimationType</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</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">_type</span>);<br/></pre>
|
|
set a annimation type.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> type of the annimation</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1093"/><h3>setAnnimationTime</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setAnnimationTime</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_time</span>);<br/></pre>
|
|
set a annimation time to produce.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_time</span> </td><td> Time in second of the annimation display</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1095"/><h3>startAnnimation</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">startAnnimation</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/></pre>
|
|
Start the annimation.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>true if an annimation will be started, false ==> no annimation and no event</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1096"/><h3>stopAnnimation</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">stopAnnimation</span> ();<br/></pre>
|
|
Stop/Break the annimation.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true if an annimation will be stoped, false ==> no curent annimation and no event wil be generated</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="1098"/><h3>onStartAnnimation</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onStartAnnimation</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Widget__annimationMode.html">ewol::Widget::annimationMode</a> <span class="code-argument">_mode</span>);<br/></pre>
|
|
Event when start the annimation.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_mode</span> </td><td> Configuring mode.</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>true need to add periodic call.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>onStopAnnimation</h3><pre>
|
|
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onStopAnnimation</span> ();<br/></pre>
|
|
Event when Stop the annimation.<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>
|