1216 lines
64 KiB
HTML
1216 lines
64 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">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1>ewol Library</h1>
|
|
<li><a href="eSystemMessage.html">eSystemMessage</a></li>
|
|
<li>ewol</li>
|
|
<ul>
|
|
<li><a href="ewol__Area.html">Area</a></li>
|
|
<li><a href="ewol__Colored3DObject.html">Colored3DObject</a></li>
|
|
<li><a href="ewol__CommandLine.html">CommandLine</a></li>
|
|
<li><a href="ewol__Compositing.html">Compositing</a></li>
|
|
<li><a href="ewol__ConfigFile.html">ConfigFile</a></li>
|
|
<li><a href="ewol__ConfigFont.html">ConfigFont</a></li>
|
|
<li><a href="ewol__Dimension.html">Dimension</a></li>
|
|
<li><a href="ewol__DrawProperty.html">DrawProperty</a></li>
|
|
<li><a href="ewol__Drawing.html">Drawing</a></li>
|
|
<li><a href="ewol__EConfig.html">EConfig</a></li>
|
|
<li><a href="ewol__EConfigElement.html">EConfigElement</a></li>
|
|
<li><a href="ewol__EMessage.html">EMessage</a></li>
|
|
<li><a href="ewol__EMultiCast.html">EMultiCast</a></li>
|
|
<li><a href="ewol__EMultiCast__MessageList.html">EMultiCast::MessageList</a></li>
|
|
<li><a href="ewol__EObject.html">EObject</a></li>
|
|
<li><a href="ewol__EObjectManager.html">EObjectManager</a></li>
|
|
<li><a href="ewol__EventEntry.html">EventEntry</a></li>
|
|
<li><a href="ewol__EventEntrySystem.html">EventEntrySystem</a></li>
|
|
<li><a href="ewol__EventExtGen.html">EventExtGen</a></li>
|
|
<li><a href="ewol__EventInput.html">EventInput</a></li>
|
|
<li><a href="ewol__EventInputSystem.html">EventInputSystem</a></li>
|
|
<li><a href="ewol__EventShortCut.html">EventShortCut</a></li>
|
|
<li><a href="ewol__EventTime.html">EventTime</a></li>
|
|
<li><a href="ewol__Face.html">Face</a></li>
|
|
<li><a href="ewol__FaceIndexing.html">FaceIndexing</a></li>
|
|
<li><a href="ewol__FontBase.html">FontBase</a></li>
|
|
<li><a href="ewol__FontFreeType.html">FontFreeType</a></li>
|
|
<li><a href="ewol__Fps.html">Fps</a></li>
|
|
<li><a href="ewol__GlyphProperty.html">GlyphProperty</a></li>
|
|
<li><a href="ewol__Image.html">Image</a></li>
|
|
<li><a href="ewol__Kerning.html">Kerning</a></li>
|
|
<li><a href="ewol__Light.html">Light</a></li>
|
|
<li><a href="ewol__Material.html">Material</a></li>
|
|
<li><a href="ewol__MaterialGlId.html">MaterialGlId</a></li>
|
|
<li><a href="ewol__Mesh.html">Mesh</a></li>
|
|
<li><a href="ewol__PhysicsBox.html">PhysicsBox</a></li>
|
|
<li><a href="ewol__PhysicsCapsule.html">PhysicsCapsule</a></li>
|
|
<li><a href="ewol__PhysicsCone.html">PhysicsCone</a></li>
|
|
<li><a href="ewol__PhysicsConvexHull.html">PhysicsConvexHull</a></li>
|
|
<li><a href="ewol__PhysicsCylinder.html">PhysicsCylinder</a></li>
|
|
<li><a href="ewol__PhysicsShape.html">PhysicsShape</a></li>
|
|
<li><a href="ewol__PhysicsSphere.html">PhysicsSphere</a></li>
|
|
<li><a href="ewol__Program.html">Program</a></li>
|
|
<li><a href="ewol__Resource.html">Resource</a></li>
|
|
<li><a href="ewol__ResourceManager.html">ResourceManager</a></li>
|
|
<li><a href="ewol__Shader.html">Shader</a></li>
|
|
<li><a href="ewol__Shaper.html">Shaper</a></li>
|
|
<li><a href="ewol__SimpleConfigElement.html">SimpleConfigElement</a></li>
|
|
<li><a href="ewol__SpecialKey.html">SpecialKey</a></li>
|
|
<li><a href="ewol__SpecialKey__SpecialKey__union__.html">SpecialKey::SpecialKey::union ::</a></li>
|
|
<li><a href="ewol__SpecialKey__union.html">SpecialKey::union </a></li>
|
|
<li><a href="ewol__Sprite.html">Sprite</a></li>
|
|
<li><a href="ewol__Text.html">Text</a></li>
|
|
<li><a href="ewol__TextDecoration.html">TextDecoration</a></li>
|
|
<li><a href="ewol__Texture.html">Texture</a></li>
|
|
<li><a href="ewol__TextureFile.html">TextureFile</a></li>
|
|
<li><a href="ewol__TexturedFont.html">TexturedFont</a></li>
|
|
<li><a href="ewol__VirtualBufferObject.html">VirtualBufferObject</a></li>
|
|
<li><a href="ewol__Widget.html">Widget</a></li>
|
|
<li><a href="ewol__WidgetManager.html">WidgetManager</a></li>
|
|
<li><a href="ewol__Windows.html">Windows</a></li>
|
|
<li><a href="ewol__eContext.html">eContext</a></li>
|
|
<li><a href="ewol__eInput.html">eInput</a></li>
|
|
<li><a href="ewol__progAttributeElement.html">progAttributeElement</a></li>
|
|
</ul>
|
|
<li>widget</li>
|
|
<ul>
|
|
<li><a href="widget__Button.html">Button</a></li>
|
|
<li><a href="widget__ButtonColor.html">ButtonColor</a></li>
|
|
<li><a href="widget__CheckBox.html">CheckBox</a></li>
|
|
<li><a href="widget__ColorBar.html">ColorBar</a></li>
|
|
<li><a href="widget__ColorChooser.html">ColorChooser</a></li>
|
|
<li><a href="widget__Composer.html">Composer</a></li>
|
|
<li><a href="widget__Container.html">Container</a></li>
|
|
<li><a href="widget__ContainerN.html">ContainerN</a></li>
|
|
<li><a href="widget__ContextMenu.html">ContextMenu</a></li>
|
|
<li><a href="widget__Entry.html">Entry</a></li>
|
|
<li><a href="widget__FileChooser.html">FileChooser</a></li>
|
|
<li><a href="widget__Gird.html">Gird</a></li>
|
|
<li><a href="widget__Gird__GirdProperties.html">Gird::GirdProperties</a></li>
|
|
<li><a href="widget__Image.html">Image</a></li>
|
|
<li><a href="widget__Joystick.html">Joystick</a></li>
|
|
<li><a href="widget__Label.html">Label</a></li>
|
|
<li><a href="widget__Layer.html">Layer</a></li>
|
|
<li><a href="widget__List.html">List</a></li>
|
|
<li><a href="widget__ListFileSystem.html">ListFileSystem</a></li>
|
|
<li><a href="widget__Menu.html">Menu</a></li>
|
|
<li><a href="widget__MenuElement.html">MenuElement</a></li>
|
|
<li><a href="widget__Mesh.html">Mesh</a></li>
|
|
<li><a href="widget__Parameter.html">Parameter</a></li>
|
|
<li><a href="widget__ParameterList.html">ParameterList</a></li>
|
|
<li><a href="widget__PopUp.html">PopUp</a></li>
|
|
<li><a href="widget__ProgressBar.html">ProgressBar</a></li>
|
|
<li><a href="widget__Scroll.html">Scroll</a></li>
|
|
<li><a href="widget__Sizer.html">Sizer</a></li>
|
|
<li><a href="widget__Slider.html">Slider</a></li>
|
|
<li><a href="widget__Spacer.html">Spacer</a></li>
|
|
<li><a href="widget__StdPopUp.html">StdPopUp</a></li>
|
|
<li><a href="widget__WSlider.html">WSlider</a></li>
|
|
<li><a href="widget__WidgetScrooled.html">WidgetScrooled</a></li>
|
|
<li><a href="widget__elementPL.html">elementPL</a></li>
|
|
</ul>
|
|
</ul>
|
|
<li>ewol</li>
|
|
<ul>
|
|
<li><a href="ewol__clipBoard__clipboardListe.html">clipBoard::clipboardListe</a></li>
|
|
<li><a href="ewol__cursorDisplay.html">cursorDisplay</a></li>
|
|
<li><a href="ewol__font__mode.html">font::mode</a></li>
|
|
<li><a href="ewol__gravity.html">gravity</a></li>
|
|
<li><a href="ewol__keyEvent__keyboard.html">keyEvent::keyboard</a></li>
|
|
<li><a href="ewol__keyEvent__status.html">keyEvent::status</a></li>
|
|
<li><a href="ewol__keyEvent__type.html">keyEvent::type</a></li>
|
|
<li><a href="ewol__openGL__openGlFlags.html">openGL::openGlFlags</a></li>
|
|
<li><a href="ewol__orientation.html">orientation</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: ewol::Widget</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Widget">Widget</a> (<span class="code-type">void</span>);<br>+ ~<a class="code-function" href="#Widget">Widget</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setUpperWidget">setUpperWidget</a> (<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_upper</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#removeUpperWidget">removeUpperWidget</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <a class="code-function" href="#getUpperWidget">getUpperWidget</a> (<span class="code-type">void</span>);<br>+ vec2 <a class="code-function" href="#relativePosition">relativePosition</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#calculateSize">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_available</span>);<br>+ vec2 <a class="code-function" href="#getSize">getSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#calculateMinMaxSize">calculateMinMaxSize</a> (<span class="code-type">void</span>);<br>+ vec2 <a class="code-function" href="#getCalculateMinSize">getCalculateMinSize</a> (<span class="code-type">void</span>);<br>+ vec2 <a class="code-function" href="#getCalculateMaxSize">getCalculateMaxSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setOffset">setOffset</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newVal</span>);<br>+ <span class="code-storage-keyword">const</span> vec2 & <a class="code-function" href="#getOffset">getOffset</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setZoom">setZoom</a> (<span class="code-type">float</span> <span class="code-argument">_newVal</span>);<br>+ <span class="code-type">float</span> <a class="code-function" href="#getZoom">getZoom</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setOrigin">setOrigin</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br>+ vec2 <a class="code-function" href="#getOrigin">getOrigin</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setMinSize">setMinSize</a> (<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-argument">_size</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setNoMinSize">setNoMinSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <a class="code-function" href="#getMinSize">getMinSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#checkMinSize">checkMinSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setMaxSize">setMaxSize</a> (<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-argument">_size</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setNoMaxSize">setNoMaxSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <a class="code-function" href="#getMaxSize">getMaxSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#checkMaxSize">checkMaxSize</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setExpand">setExpand</a> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newExpand</span>);<br>+ bvec2 <a class="code-function" href="#getExpand">getExpand</a> (<span class="code-type">void</span>);<br>+ bvec2 <a class="code-function" href="#canExpand">canExpand</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setFill">setFill</a> (<span class="code-storage-keyword">const</span> bvec2 & <span class="code-argument">_newFill</span>);<br>+ <span class="code-storage-keyword">const</span> bvec2 & <a class="code-function" href="#getFill">getFill</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> bvec2 & <a class="code-function" href="#canFill">canFill</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#hide">hide</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#show">show</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#isHide">isHide</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setGravity">setGravity</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__gravity.html" class="code-type">ewol::gravity</a> <span class="code-argument">_gravity</span>);<br>+ <span class="code-storage-keyword">enum</span> <a href="ewol__gravity.html" class="code-type">ewol::gravity</a> <a class="code-function" href="#getGravity">getGravity</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getFocus">getFocus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#canHaveFocus">canHaveFocus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#setFocus">setFocus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#rmFocus">rmFocus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setCanHaveFocus">setCanHaveFocus</a> (<span class="code-type">bool</span> <span class="code-argument">_canFocusState</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#keepFocus">keepFocus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#getMouseLimit">getMouseLimit</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setMouseLimit">setMouseLimit</a> (<span class="code-type">int32_t</span> <span class="code-argument">_numberState</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getKeyboardRepeate">getKeyboardRepeate</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int64_t</span> <a class="code-function" href="#systemGetCallDeltaTime">systemGetCallDeltaTime</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int64_t</span> <a class="code-function" href="#systemGetLastCallTime">systemGetLastCallTime</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#systemSetLastCallTime">systemSetLastCallTime</a> (<span class="code-type">int64_t</span> <span class="code-argument">_time</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#periodicCall">periodicCall</a> (<span class="code-storage-keyword">const</span> <a href="ewol__EventTime.html" class="code-type">ewol::EventTime</a> & <span class="code-argument">_event</span>);<br>+ <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <a class="code-function" href="#getWidgetAtPos">getWidgetAtPos</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);<br>+ <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <a class="code-function" href="#getWidgetNamed">getWidgetNamed</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">_widgetName</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#systemEventInput">systemEventInput</a> (<a href="ewol__EventInputSystem.html" class="code-type">ewol::EventInputSystem</a> & <span class="code-argument">_event</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#systemEventEntry">systemEventEntry</a> (<a href="ewol__EventEntrySystem.html" class="code-type">ewol::EventEntrySystem</a> & <span class="code-argument">_event</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onEventClipboard">onEventClipboard</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__clipBoard__clipboardListe.html" class="code-type">ewol::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#onEventShortCut">onEventShortCut</a> (<a href="ewol__SpecialKey.html" class="code-type">ewol::SpecialKey</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 href="ewol__keyEvent__keyboard.html" class="code-type">ewol::keyEvent::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">void</span> <a class="code-function" href="#systemDraw">systemDraw</a> (<span class="code-storage-keyword">const</span> DrawProperty & <span class="code-argument">_displayProp</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onRegenerateDisplay">onRegenerateDisplay</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#grabCursor">grabCursor</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#unGrabCursor">unGrabCursor</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getGrabStatus">getGrabStatus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setCursor">setCursor</a> (<span class="code-storage-keyword">enum</span> <a href="ewol__cursorDisplay.html" class="code-type">ewol::cursorDisplay</a> <span class="code-argument">_newCursor</span>);<br>+ <span class="code-storage-keyword">enum</span> <a href="ewol__cursorDisplay.html" class="code-type">ewol::cursorDisplay</a> <a class="code-function" href="#getCursor">getCursor</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#onObjectRemove">onObjectRemove</a> (<a href="ewol__EObject.html" class="code-type">ewol::EObject</a> * <span class="code-argument">_removeObject</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#loadXML">loadXML</a> (<a href="http://HeeroYui.github.io/exml/doc/doc//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#requestUpdateSize">requestUpdateSize</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__WidgetManager.html" class="code-type">ewol::WidgetManager</a> & <a class="code-function" href="#getWidgetManager">getWidgetManager</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__Windows.html" class="code-type">ewol::Windows</a> * <a class="code-function" href="#getWindows">getWindows</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setAnnimationType">setAnnimationType</a> (<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</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">_type</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setAnnimationTime">setAnnimationTime</a> (<span class="code-storage-keyword">enum</span> annimationMode <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="#startAnnimation">startAnnimation</a> (<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#stopAnnimation">stopAnnimation</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#onGetFocus">onGetFocus</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#onLostFocus">onLostFocus</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#setKeyboardRepeate">setKeyboardRepeate</a> (<span class="code-type">bool</span> <span class="code-argument">_state</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#showKeyboard">showKeyboard</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#hideKeyboard">hideKeyboard</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#periodicCallDisable">periodicCallDisable</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#periodicCallEnable">periodicCallEnable</a> (<span class="code-type">float</span> <span class="code-argument">_callInSecond</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#onEventInput">onEventInput</a> (<span class="code-storage-keyword">const</span> <a href="ewol__EventInput.html" class="code-type">ewol::EventInput</a> & <span class="code-argument">_event</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#onEventEntry">onEventEntry</a> (<span class="code-storage-keyword">const</span> <a href="ewol__EventEntry.html" class="code-type">ewol::EventEntry</a> & <span class="code-argument">_event</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#shortCutAdd">shortCutAdd</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_descriptiveString</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>,<br/> <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">bool</span> <span class="code-argument">_broadcast</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#shortCutClean">shortCutClean</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#markToRedraw">markToRedraw</a> (<span class="code-type">void</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#needRedraw">needRedraw</a> (<span class="code-type">void</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#onDraw">onDraw</a> (<span class="code-type">void</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__EConfig.html" class="code-type">ewol::EConfig</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># <span class="code-type">void</span> <a class="code-function" href="#addAnnimationType">addAnnimationType</a> (<span class="code-storage-keyword">enum</span> annimationMode <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">bool</span> <a class="code-function" href="#onStartAnnimation">onStartAnnimation</a> (<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#onStopAnnimation">onStopAnnimation</a> (<span class="code-type">void</span>);<br></pre>
|
|
|
|
|
|
<h2>Object Hierarchy:</h2>
|
|
<pre>
|
|
<a href="ewol__EObject.html">ewol::EObject</a>
|
|
+--> <b>ewol::Widget</b>
|
|
+--> <a href="widget__ContainerN.html">widget::ContainerN</a>
|
|
+--> <a href="widget__ProgressBar.html">widget::ProgressBar</a>
|
|
+--> <a href="widget__Slider.html">widget::Slider</a>
|
|
+--> <a href="widget__Entry.html">widget::Entry</a>
|
|
+--> <a href="widget__Spacer.html">widget::Spacer</a>
|
|
+--> <a href="widget__Joystick.html">widget::Joystick</a>
|
|
+--> <a href="widget__Container.html">widget::Container</a>
|
|
+--> <a href="ewol__Windows.html">ewol::Windows</a>
|
|
+--> <a href="widget__ColorBar.html">widget::ColorBar</a>
|
|
+--> <a href="widget__ButtonColor.html">widget::ButtonColor</a>
|
|
+--> <a href="widget__Label.html">widget::Label</a>
|
|
+--> <a href="widget__Mesh.html">widget::Mesh</a>
|
|
+--> <a href="widget__Button.html">widget::Button</a>
|
|
+--> <a href="widget__WidgetScrooled.html">widget::WidgetScrooled</a>
|
|
+--> <a href="widget__Image.html">widget::Image</a>
|
|
+--> <a href="widget__Gird.html">widget::Gird</a>
|
|
+--> <a href="widget__CheckBox.html">widget::CheckBox</a>
|
|
</pre>
|
|
<br/>
|
|
<h2>Description:</h2>
|
|
/**
|
|
* @ingroup ewolWidgetGroup
|
|
*/<h2>Detail:<h2>
|
|
<h3>ewol::<a id="Widget">Widget</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Widget</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Constructor of the widget classes
|
|
<br/><ul>
|
|
<b>Return:</b> (no execption generated (not managed in embended platform))
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>ewol::~<a id="Widget">Widget</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">Widget</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Destructor of the widget classes
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setUpperWidget">setUpperWidget</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setUpperWidget</span>(<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_upper</span>);</pre>
|
|
<br/>
|
|
set the upper widget of this widget.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_upper</span> Father widget (only keep the last and write error if a previous was set) == > disable with NULL.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="removeUpperWidget">removeUpperWidget</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">removeUpperWidget</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
remove the upper widget of this widget.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getUpperWidget">getUpperWidget</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-function">getUpperWidget</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the upper widget (father).
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="relativePosition">relativePosition</a> ()</h3>
|
|
|
|
<pre>
|
|
vec2 <span class="code-function">relativePosition</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
convert the absolute position in the local Position (Relative)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_pos</span> Absolute position that you request convertion
|
|
<br/><b>Return:</b> the relative position
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="calculateSize">calculateSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
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>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_available</span> Available x&y pixel size
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getSize">getSize</a> ()</h3>
|
|
|
|
<pre>
|
|
vec2 <span class="code-function">getSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the widget size
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Return:</b> Requested size
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="calculateMinMaxSize">calculateMinMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">calculateMinMaxSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
calculate the minimum and maximum size (need to estimate expend properties of the widget)
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getCalculateMinSize">getCalculateMinSize</a> ()</h3>
|
|
|
|
<pre>
|
|
vec2 <span class="code-function">getCalculateMinSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the widget minimum size calculated
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Return:</b> Requested size
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getCalculateMaxSize">getCalculateMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
vec2 <span class="code-function">getCalculateMaxSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the widget maximum size calculated
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Return:</b> Requested size
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setOffset">setOffset</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
set the zoom property of the widget.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newVal</span> offset value.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getOffset">getOffset</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> vec2 & <span class="code-function">getOffset</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the offset property of the widget.
|
|
<br/><ul>
|
|
<b>Return:</b> The current offset value.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setZoom">setZoom</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setZoom</span>(<span class="code-type">float</span> <span class="code-argument">_newVal</span>);</pre>
|
|
<br/>
|
|
set the zoom property of the widget
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newVal</span> newZoom value
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getZoom">getZoom</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">float</span> <span class="code-function">getZoom</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the zoom property of the widget
|
|
<br/><ul>
|
|
<b>Return:</b> the current zoom value
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setOrigin">setOrigin</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
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>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_pos</span> Position of the origin
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getOrigin">getOrigin</a> ()</h3>
|
|
|
|
<pre>
|
|
vec2 <span class="code-function">getOrigin</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the origin (obsolute position in the windows)
|
|
<br/><ul>
|
|
<b>Return:</b> coordonate of the origin requested
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setMinSize">setMinSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setMinSize</span>(<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-argument">_size</span>);</pre>
|
|
<br/>
|
|
User set the minimum size he want to set the display
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_size</span> set minimum size (none : 0)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setNoMinSize">setNoMinSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setNoMinSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
User set No minimum size.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getMinSize">getMinSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-function">getMinSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the current calculated min size
|
|
<br/><ul>
|
|
<b>Return:</b> the size requested
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="checkMinSize">checkMinSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">checkMinSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
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>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setMaxSize">setMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setMaxSize</span>(<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-argument">_size</span>);</pre>
|
|
<br/>
|
|
User set the maximum size he want to set the display
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_size</span> The new maximum size requested (vec2(0,0) to unset)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setNoMaxSize">setNoMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setNoMaxSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
User set No maximum size.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getMaxSize">getMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="ewol__Dimension.html" class="code-type">ewol::Dimension</a> & <span class="code-function">getMaxSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the current maximum size
|
|
<br/><ul>
|
|
<b>Return:</b> the size requested
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="checkMaxSize">checkMaxSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">checkMaxSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
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>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setExpand">setExpand</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
set the expend capabilities (x&y)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newExpend</span> 2D boolean repensent the capacity to expend
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getExpand">getExpand</a> ()</h3>
|
|
|
|
<pre>
|
|
bvec2 <span class="code-function">getExpand</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the expend capabilities (x&y) (set by the user)
|
|
<br/><ul>
|
|
<b>Return:</b> 2D boolean repensent the capacity to expend
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="canExpand">canExpand</a> ()</h3>
|
|
|
|
<pre>
|
|
bvec2 <span class="code-function">canExpand</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the expend capabilities (x&y)
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Return:</b> 2D boolean repensent the capacity to expend
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setFill">setFill</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
set the x&y filling capacity
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newFill</span> new x&y fill state
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getFill">getFill</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> bvec2 & <span class="code-function">getFill</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
set the x&y filling capacity set by the user
|
|
<br/><ul>
|
|
<b>Return:</b> bvec2 repensent the capacity to x&y filling (set by the user)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="canFill">canFill</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> bvec2 & <span class="code-function">canFill</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the filling capabilities x&y
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Return:</b> bvec2 repensent the capacity to x&y filling
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="hide">hide</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">hide</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
set the widget hidden
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="show">show</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">show</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
set the widget visible
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="isHide">isHide</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">isHide</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the visibility of the widget
|
|
<br/><ul>
|
|
<b>Return:</b> true: if the widget is hiden, false: it is visible
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setGravity">setGravity</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setGravity</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__gravity.html" class="code-type">ewol::gravity</a> <span class="code-argument">_gravity</span>);</pre>
|
|
<br/>
|
|
set the widget gravity
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_gravity</span> New gravity of the widget
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getGravity">getGravity</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">enum</span> <a href="ewol__gravity.html" class="code-type">ewol::gravity</a> <span class="code-function">getGravity</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the widget gravity
|
|
<br/><ul>
|
|
<b>Return:</b> the gravity type
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getFocus">getFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the focus state of the widget
|
|
<br/><ul>
|
|
<b>Return:</b> focus state
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="canHaveFocus">canHaveFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">canHaveFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the capability to have focus
|
|
<br/><ul>
|
|
<b>Return:</b> State capability to have focus
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setFocus">setFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">setFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
set focus on this widget
|
|
<br/><ul>
|
|
<b>Return:</b> return true if the widget keep the focus
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="rmFocus">rmFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">rmFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
remove the focus on this widget
|
|
<br/><ul>
|
|
<b>Return:</b> return true if the widget have release his focus (if he has it)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setCanHaveFocus">setCanHaveFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setCanHaveFocus</span>(<span class="code-type">bool</span> <span class="code-argument">_canFocusState</span>);</pre>
|
|
<br/>
|
|
set the capability to have the focus
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_canFocusState</span> new focus capability
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="keepFocus">keepFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">keepFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
keep the focus on this widget == > this remove the previous focus on all other widget
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getMouseLimit">getMouseLimit</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int32_t</span> <span class="code-function">getMouseLimit</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the number of mouse event supported
|
|
<br/><ul>
|
|
<b>Return:</b> return the number of event that the mouse supported [0..3]
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setMouseLimit">setMouseLimit</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
get the number of mouse event supported
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_numberState</span> The number of event that the mouse supported [0..3]
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getKeyboardRepeate">getKeyboardRepeate</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getKeyboardRepeate</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the keyboard repeating event supporting.
|
|
<br/><ul>
|
|
<b>Return:</b> true : the event can be repeated.
|
|
<br/><b>Return:</b> false : the event must not be repeated.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemGetCallDeltaTime">systemGetCallDeltaTime</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int64_t</span> <span class="code-function">systemGetCallDeltaTime</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
{SYSTEM} get a reference of the periodic call delta time
|
|
<br/><ul>
|
|
<b>Return:</b> the perodic time delta call -1 : disable / 0 : every time / else in US
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemGetLastCallTime">systemGetLastCallTime</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int64_t</span> <span class="code-function">systemGetLastCallTime</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
{SYSTEM} get a reference of the periodic call time
|
|
<br/><ul>
|
|
<b>Return:</b> Last call from the periodic call
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemSetLastCallTime">systemSetLastCallTime</a> ()</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>);</pre>
|
|
<br/>
|
|
{SYSTEM} get a reference of the periodic call time
|
|
<br/><ul>
|
|
<b>Return:</b> Last call from the periodic call
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="periodicCall">periodicCall</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">periodicCall</span>(<span class="code-storage-keyword">const</span> <a href="ewol__EventTime.html" class="code-type">ewol::EventTime</a> & <span class="code-argument">_event</span>);</pre>
|
|
<br/>
|
|
periodic call of this widget
|
|
<br/><ul>
|
|
<b>Parameter:</b> <span class="code-argument">_event</span> Current time property
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getWidgetAtPos">getWidgetAtPos</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-function">getWidgetAtPos</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
get the widget at the specific windows absolute position
|
|
<br/><b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_pos</span> gAbsolute position of the requested widget knowledge
|
|
<br/><b>Return:</b> NULL No widget found
|
|
<br/><b>Return:</b> pointer on the widget found
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getWidgetNamed">getWidgetNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-function">getWidgetNamed</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">_widgetName</span>);</pre>
|
|
<br/>
|
|
get the widget if it have this name or one of the subwidget with the same name
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_widgetName</span> name of the widget
|
|
<br/><b>Return:</b> the requested pointer on the node (or NULL pointer)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemEventInput">systemEventInput</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">systemEventInput</span>(<a href="ewol__EventInputSystem.html" class="code-type">ewol::EventInputSystem</a> & <span class="code-argument">_event</span>);</pre>
|
|
<br/>
|
|
{SYSTEM} system event input (only meta widget might overwrite this function).
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_event</span> Event properties
|
|
<br/><b>Return:</b> true the event is used
|
|
<br/><b>Return:</b> false the event is not used
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemEventEntry">systemEventEntry</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">systemEventEntry</span>(<a href="ewol__EventEntrySystem.html" class="code-type">ewol::EventEntrySystem</a> & <span class="code-argument">_event</span>);</pre>
|
|
<br/>
|
|
{SYSTEM} Entry event (only meta widget might overwrite this function).
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_event</span> Event properties
|
|
<br/><b>Return:</b> true if the event has been used
|
|
<br/><b>Return:</b> false if the event has not been used
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onEventClipboard">onEventClipboard</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onEventClipboard</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__clipBoard__clipboardListe.html" class="code-type">ewol::clipBoard::clipboardListe</a> <span class="code-argument">_clipboardID</span>);</pre>
|
|
<br/>
|
|
Event on a past event == > this event is asynchronous due to all system does not support direct getting datas
|
|
<br/><b>Notes:</b> : need to have focus ...
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">mode</span> Mode of data requested
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onEventShortCut">onEventShortCut</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">onEventShortCut</span>(<a href="ewol__SpecialKey.html" class="code-type">ewol::SpecialKey</a> & <span class="code-argument">_special</span>,
|
|
<span class="code-type">char32_t</span> <span class="code-argument">_unicodeValue</span>,
|
|
<span class="code-storage-keyword">enum</span> <a href="ewol__keyEvent__keyboard.html" class="code-type">ewol::keyEvent::keyboard</a> <span class="code-argument">_kbMove</span>,
|
|
<span class="code-type">bool</span> <span class="code-argument">_isDown</span>);</pre>
|
|
<br/>
|
|
Event on a short-cut of this Widget (in case of return false, the event on the keyevent will arrive in the function <br/><b>Notes:</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>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_special</span> All the special kay pressed at this time.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_unicodeValue</span> Key pressed by the user not used if the kbMove!=ewol::EVENT_KB_MOVE_TYPE_NONE.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_kbMove</span> Special key of the keyboard.
|
|
<br/><b>Return:</b> true if the event has been used.
|
|
<br/><b>Return:</b> false if the event has not been used.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="systemDraw">systemDraw</a> ()</h3>
|
|
|
|
<pre>
|
|
<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>);</pre>
|
|
<br/>
|
|
{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>Notes:</b> This function is virtual for the scrolled widget, and the more complicated openGl widget
|
|
<br/> <b>Notes:</b> : INTERNAL EWOL SYSTEM
|
|
<br/> <ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_displayProp</span> properties of the current display
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onRegenerateDisplay">onRegenerateDisplay</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onRegenerateDisplay</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Event generated when a redraw is needed
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="grabCursor">grabCursor</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">grabCursor</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Grab the cursor : This get all the mouvement of the mouse in PC mode, and generate an ofset instead of a position.
|
|
<br/><b>Notes:</b> : the generation of the offset is due to the fact the cursor position is forced at the center of the widget.
|
|
<br/> <b>Notes:</b> This done nothing in "Finger" or "Stylet" mode.
|
|
<br/> <br/>
|
|
|
|
<hr/>
|
|
<h3><a id="unGrabCursor">unGrabCursor</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">unGrabCursor</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Un-Grab the cursor (default mode cursor offset)
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getGrabStatus">getGrabStatus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getGrabStatus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the grabbing status of the cursor.
|
|
<br/><ul>
|
|
<b>Return:</b> true if the cursor is curently grabbed
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setCursor">setCursor</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setCursor</span>(<span class="code-storage-keyword">enum</span> <a href="ewol__cursorDisplay.html" class="code-type">ewol::cursorDisplay</a> <span class="code-argument">_newCursor</span>);</pre>
|
|
<br/>
|
|
set the cursor display type.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newCursor</span> selected new cursor.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getCursor">getCursor</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">enum</span> <a href="ewol__cursorDisplay.html" class="code-type">ewol::cursorDisplay</a> <span class="code-function">getCursor</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the currrent cursor.
|
|
<br/><ul>
|
|
<b>Return:</b> the type of the cursor.
|
|
<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__EObject.html" class="code-type">ewol::EObject</a> * <span class="code-argument">_removeObject</span>);</pre>
|
|
<br/>
|
|
<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/doc/doc//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="requestUpdateSize">requestUpdateSize</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">requestUpdateSize</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
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/>
|
|
<h3><a id="getWidgetManager">getWidgetManager</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__WidgetManager.html" class="code-type">ewol::WidgetManager</a> & <span class="code-function">getWidgetManager</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the current Widget Manager
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getWindows">getWindows</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="ewol__Windows.html" class="code-type">ewol::Windows</a> * <span class="code-function">getWindows</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Windows
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setAnnimationType">setAnnimationType</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setAnnimationType</span>(<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</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/>
|
|
set a annimation type.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_mode</span> Configuring mode.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_type</span> type of the annimation
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setAnnimationTime">setAnnimationTime</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setAnnimationTime</span>(<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>,
|
|
<span class="code-type">float</span> <span class="code-argument">_time</span>);</pre>
|
|
<br/>
|
|
set a annimation time to produce.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_mode</span> Configuring mode.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_time</span> Time in second of the annimation display
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="startAnnimation">startAnnimation</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">startAnnimation</span>(<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>);</pre>
|
|
<br/>
|
|
Start the annimation.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_mode</span> Configuring mode.
|
|
<br/><b>Return:</b> true if an annimation will be started, false ==> no annimation and no event
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="stopAnnimation">stopAnnimation</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">stopAnnimation</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Stop/Break the annimation.
|
|
<br/><ul>
|
|
<b>Return:</b> true if an annimation will be stoped, false ==> no curent annimation and no event wil be generated
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onGetFocus">onGetFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onGetFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Event of the focus has been grep by the current widget
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onLostFocus">onLostFocus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onLostFocus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Event of the focus has been lost by the current widget
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setKeyboardRepeate">setKeyboardRepeate</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setKeyboardRepeate</span>(<span class="code-type">bool</span> <span class="code-argument">_state</span>);</pre>
|
|
<br/>
|
|
set the keyboard repeating event supporting.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_state</span> The repeating status (true: enable, false disable).
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="showKeyboard">showKeyboard</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">showKeyboard</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
display the virtual keyboard (if needed)
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="hideKeyboard">hideKeyboard</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">hideKeyboard</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Hide the virtual keyboard (if needed)
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="periodicCallDisable">periodicCallDisable</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">periodicCallDisable</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
disable the periodic call.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="periodicCallEnable">periodicCallEnable</a> ()</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>);</pre>
|
|
<br/>
|
|
disable the periodic call.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_callInSecond</span> periodic call in second (float)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onEventInput">onEventInput</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">onEventInput</span>(<span class="code-storage-keyword">const</span> <a href="ewol__EventInput.html" class="code-type">ewol::EventInput</a> & <span class="code-argument">_event</span>);</pre>
|
|
<br/>
|
|
Event on an input of this Widget (finger, mouse, stilet)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_event</span> Event properties
|
|
<br/><b>Return:</b> true the event is used
|
|
<br/><b>Return:</b> false the event is not used
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onEventEntry">onEventEntry</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">onEventEntry</span>(<span class="code-storage-keyword">const</span> <a href="ewol__EventEntry.html" class="code-type">ewol::EventEntry</a> & <span class="code-argument">_event</span>);</pre>
|
|
<br/>
|
|
Entry event.
|
|
represent the physical event :
|
|
- Keyboard (key event and move event)
|
|
- Accelerometer
|
|
- Joystick
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_event</span> Event properties
|
|
<br/><b>Return:</b> true if the event has been used
|
|
<br/><b>Return:</b> false if the event has not been used
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="shortCutAdd">shortCutAdd</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">shortCutAdd</span>(<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_descriptiveString</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_generateEventId</span>,
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-argument">_data</span>,
|
|
<span class="code-type">bool</span> <span class="code-argument">_broadcast</span>);</pre>
|
|
<br/>
|
|
add a specific shortcut with his description
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_descriptiveString</span> Description string of the shortcut
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_generateEventId</span> Event generic of the element
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_data</span> Associate data wit the event
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="shortCutClean">shortCutClean</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">shortCutClean</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
remove all curent shortCut
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="markToRedraw">markToRedraw</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">markToRedraw</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
The widget mark itself that it need to regenerate the nest time.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="needRedraw">needRedraw</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">needRedraw</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the need of the redrawing of the widget and reset it to false
|
|
<br/><ul>
|
|
<b>Return:</b> true if we need to redraw
|
|
<br/><b>Return:</b> false if we have no need to redraw
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onDraw">onDraw</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onDraw</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Common widget drawing function (called by the drawing thread [Android, X11, ...])
|
|
<br/><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__EConfig.html" class="code-type">ewol::EConfig</a> & <span class="code-argument">_conf</span>);</pre>
|
|
<br/>
|
|
<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/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="addAnnimationType">addAnnimationType</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">addAnnimationType</span>(<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>,
|
|
<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_type</span>);</pre>
|
|
<br/>
|
|
Add a annimation type capabilities of this widget.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_mode</span> Configuring mode.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_type</span> Type of the annimation.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onStartAnnimation">onStartAnnimation</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">onStartAnnimation</span>(<span class="code-storage-keyword">enum</span> annimationMode <span class="code-argument">_mode</span>);</pre>
|
|
<br/>
|
|
Event when start the annimation.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_mode</span> Configuring mode.
|
|
<br/><b>Return:</b> true need to add periodic call.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="onStopAnnimation">onStopAnnimation</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">onStopAnnimation</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Event when Stop the annimation.
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|