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

436 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>ewol Library</title>
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1>ewol Library</h1>
<div id="menu">
<h2>ewol</h2>
<ul class="niveau1">
<li class="sousmenu"><a>compositing</a>
<ul class="niveau2">
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__compositing__Area.html">Area</a></li>
<li><a href="ewol__compositing__Drawing.html">Drawing</a></li>
<li><a href="ewol__compositing__Image.html">Image</a></li>
<li><a href="ewol__compositing__Shaper.html">Shaper</a></li>
<li><a href="ewol__compositing__Sprite.html">Sprite</a></li>
<li><a href="ewol__compositing__Text.html">Text</a></li>
</ul>
</li>
<li class="sousmenu"><a>context</a>
<ul class="niveau2">
<li><a href="ewol__Context.html">Context</a></li>
<li><a href="ewol__context__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__context__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__context__InputManager.html">InputManager</a></li>
<li class="sousmenu"><a href="ewol__context__clipBoard.html">clipBoard</a>
<ul class="niveau3">
<li><a href="ewol__context__clipBoard.html::clipboardListe">clipboardListe</a></li>
</ul>
</li>
<li><a href="ewol__context__cursorDisplay.html">cursorDisplay</a></li>
</ul>
</li>
<li class="sousmenu"><a>event</a>
<ul class="niveau2">
<li><a href="ewol__event__Entry.html">Entry</a></li>
<li><a href="ewol__event__EntrySystem.html">EntrySystem</a></li>
<li><a href="ewol__event__Input.html">Input</a></li>
<li><a href="ewol__event__InputSystem.html">InputSystem</a></li>
<li><a href="ewol__event__Time.html">Time</a></li>
</ul>
</li>
<li class="sousmenu"><a>key</a>
<ul class="niveau2">
<li><a href="ewol__key__Special.html">Special</a></li>
<li><a href="ewol__key__keyboard.html">keyboard</a></li>
<li><a href="ewol__key__status.html">status</a></li>
<li><a href="ewol__key__type.html">type</a></li>
</ul>
</li>
<li class="sousmenu"><a>object</a>
<ul class="niveau2">
<li><a href="ewol__Object.html">Object</a></li>
<li><a href="ewol__object__Config.html">Config</a></li>
<li><a href="ewol__object__ConfigElement.html">ConfigElement</a></li>
<li><a href="ewol__object__Manager.html">Manager</a></li>
<li><a href="ewol__object__Message.html">Message</a></li>
<li class="sousmenu"><a href="ewol__object__MultiCast.html">MultiCast</a>
<ul class="niveau3">
<li><a href="ewol__object__MultiCast.html::MessageList">MessageList</a></li>
</ul>
</li>
</ul>
</li>
<li class="sousmenu"><a>openGL</a>
<ul class="niveau2">
<li><a href="ewol__openGL__openGlFlags.html">openGlFlags</a></li>
</ul>
</li>
<li class="sousmenu"><a>resource</a>
<ul class="niveau2">
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__resource__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__resource__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__resource__FontBase.html">FontBase</a></li>
<li><a href="ewol__resource__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__resource__Manager.html">Manager</a></li>
<li><a href="ewol__resource__Program.html">Program</a></li>
<li><a href="ewol__resource__Shader.html">Shader</a></li>
<li><a href="ewol__resource__Texture.html">Texture</a></li>
<li><a href="ewol__resource__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__resource__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__resource__VirtualBufferObject.html">VirtualBufferObject</a></li>
</ul>
</li>
<li class="sousmenu"><a>widget</a>
<ul class="niveau2">
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__widget__Button.html">Button</a></li>
<li><a href="ewol__widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="ewol__widget__CheckBox.html">CheckBox</a></li>
<li><a href="ewol__widget__ColorBar.html">ColorBar</a></li>
<li><a href="ewol__widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="ewol__widget__Composer.html">Composer</a></li>
<li><a href="ewol__widget__Container.html">Container</a></li>
<li><a href="ewol__widget__ContainerN.html">ContainerN</a></li>
<li><a href="ewol__widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="ewol__widget__Entry.html">Entry</a></li>
<li><a href="ewol__widget__FileChooser.html">FileChooser</a></li>
<li class="sousmenu"><a href="ewol__widget__Gird.html">Gird</a>
<ul class="niveau3">
<li><a href="ewol__widget__Gird.html::GirdProperties">GirdProperties</a></li>
</ul>
</li>
<li><a href="ewol__widget__Image.html">Image</a></li>
<li><a href="ewol__widget__Joystick.html">Joystick</a></li>
<li><a href="ewol__widget__Label.html">Label</a></li>
<li><a href="ewol__widget__Layer.html">Layer</a></li>
<li><a href="ewol__widget__List.html">List</a></li>
<li><a href="ewol__widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="ewol__widget__Manager.html">Manager</a></li>
<li><a href="ewol__widget__Menu.html">Menu</a></li>
<li><a href="ewol__widget__MenuElement.html">MenuElement</a></li>
<li><a href="ewol__widget__Parameter.html">Parameter</a></li>
<li><a href="ewol__widget__ParameterList.html">ParameterList</a></li>
<li><a href="ewol__widget__PopUp.html">PopUp</a></li>
<li><a href="ewol__widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="ewol__widget__Scroll.html">Scroll</a></li>
<li><a href="ewol__widget__Sizer.html">Sizer</a></li>
<li><a href="ewol__widget__Slider.html">Slider</a></li>
<li><a href="ewol__widget__Spacer.html">Spacer</a></li>
<li><a href="ewol__widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="ewol__widget__WSlider.html">WSlider</a></li>
<li><a href="ewol__widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="ewol__widget__Windows.html">Windows</a></li>
<li><a href="ewol__widget__elementPL.html">elementPL</a></li>
</ul>
</li>
<ul>
<h3> </h3>
</div>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::widget::Button</h1>
<br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#Button">Button</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">_shaperName</span>);<br>+ ~<a class="code-function" href="#Button">Button</a> (<span class="code-type">void</span>);<br></pre>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-storage-keyword">static</span> <span class="code-type">void</span> <a class="code-function" href="#init">init</a> (<a href="ewol__widget__Manager.html" class="code-type">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setShaperName">setShaperName</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">_shaperName</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setSubWidget">setSubWidget</a> (<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_subWidget</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setSubWidgetToggle">setSubWidgetToggle</a> (<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_subWidget</span>);<br>+ <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <a class="code-function" href="#getSubWidget">getSubWidget</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <a class="code-function" href="#getSubWidgetToggle">getSubWidgetToggle</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setValue">setValue</a> (<span class="code-type">bool</span> <span class="code-argument">_val</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getValue">getValue</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setLock">setLock</a> (<span class="code-storage-keyword">enum</span> buttonLock <span class="code-argument">_lock</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setToggleMode">setToggleMode</a> (<span class="code-type">bool</span> <span class="code-argument">_togg</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getToggleMode">getToggleMode</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>+ <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">_availlable</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="#systemDraw">systemDraw</a> (<span class="code-storage-keyword">const</span> <a href="ewol__DrawProperty.html" class="code-type">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</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__event__Input.html" class="code-type">ewol::event::Input</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__event__Entry.html" class="code-type">ewol::event::Entry</a> & <span class="code-argument">_event</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#loadXML">loadXML</a> (<a href="http://HeeroYui.github.io/exml//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);<br>+ <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">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__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#onGetConfig">onGetConfig</a> (<span class="code-storage-keyword">const</span> <span class="code-type">char</span> * <span class="code-argument">_config</span>,<br/> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_result</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#changeStatusIn">changeStatusIn</a> (<span class="code-type">int32_t</span> <span class="code-argument">_newStatusId</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#CheckStatus">CheckStatus</a> (<span class="code-type">void</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__event__Time.html" class="code-type">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br></pre>
<h2>Object Hierarchy:</h2>
<pre>
<a href="ewol__Object.html">ewol::Object</a>
+--> <a href="ewol__Widget.html">ewol::Widget</a>
+--> <b>ewol::widget::Button</b>
</pre>
<br/>
<h2>Description:</h2>
/**
* @ingroup ewolWidgetGroup
* @brief a composed button is a button with an inside composed with the specify XML element == > this permit to generate standard element simple
*/<h2>Detail:<h2>
<h3>ewol::widget::<a id="init">init</a> ()</h3>
<pre>
<span class="code-storage-keyword">static</span> <span class="code-type">void</span> <span class="code-function">init</span>(<a href="ewol__widget__Manager.html" class="code-type">ewol::widget::Manager</a> & <span class="code-argument">_widgetManager</span>);</pre>
<br/>
<br/>
<hr/>
<h3>ewol::widget::<a id="Button">Button</a> ()</h3>
<pre>
<span class="code-function">Button</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">_shaperName</span>);</pre>
<br/>
Constructor
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_shaperName</span> Shaper file properties
<br/></ul>
<br/>
<hr/>
<h3>ewol::widget::~<a id="Button">Button</a> ()</h3>
<pre>
~<span class="code-function">Button</span>(<span class="code-type">void</span>);</pre>
<br/>
Destructor
<br/><br/>
<hr/>
<h3><a id="setShaperName">setShaperName</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setShaperName</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">_shaperName</span>);</pre>
<br/>
set the shaper name (use the contructer one this permit to not noad unused shaper)
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_shaperName</span> The new shaper filename
<br/></ul>
<br/>
<hr/>
<h3><a id="setSubWidget">setSubWidget</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setSubWidget</span>(<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_subWidget</span>);</pre>
<br/>
Specify the current widget
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_subWidget</span> Widget to add normal
<br/></ul>
<br/>
<hr/>
<h3><a id="setSubWidgetToggle">setSubWidgetToggle</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setSubWidgetToggle</span>(<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-argument">_subWidget</span>);</pre>
<br/>
Specify the current widget
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_subWidget</span> Widget to add Toggle
<br/></ul>
<br/>
<hr/>
<h3><a id="getSubWidget">getSubWidget</a> ()</h3>
<pre>
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-function">getSubWidget</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current displayed composition
<br/><ul>
<b>Return:</b> The base widget
<br/></ul>
<br/>
<hr/>
<h3><a id="getSubWidgetToggle">getSubWidgetToggle</a> ()</h3>
<pre>
<a href="ewol__Widget.html" class="code-type">ewol::Widget</a> * <span class="code-function">getSubWidgetToggle</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current displayed composition
<br/><ul>
<b>Return:</b> The toggle widget
<br/></ul>
<br/>
<hr/>
<h3><a id="setValue">setValue</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setValue</span>(<span class="code-type">bool</span> <span class="code-argument">_val</span>);</pre>
<br/>
set the currentValue of the Button (pressed or not)
<br/><b>Notes:</b> Work only in toggle mode
<br/> <ul>
<b>Parameter [input]:</b> <span class="code-argument">_val</span> New value of the button
<br/></ul>
<br/>
<hr/>
<h3><a id="getValue">getValue</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">getValue</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current button value.
<br/><ul>
<b>Return:</b> True : The button is pressed.
<br/><b>Return:</b> false : The button is released.
<br/></ul>
<br/>
<hr/>
<h3><a id="setLock">setLock</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setLock</span>(<span class="code-storage-keyword">enum</span> buttonLock <span class="code-argument">_lock</span>);</pre>
<br/>
set the button lock state.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_lock</span> New lock mode of the button
<br/></ul>
<br/>
<hr/>
<h3><a id="setToggleMode">setToggleMode</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setToggleMode</span>(<span class="code-type">bool</span> <span class="code-argument">_togg</span>);</pre>
<br/>
change the toggle mode.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_togg</span> New toggle mode
<br/></ul>
<br/>
<hr/>
<h3><a id="getToggleMode">getToggleMode</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">getToggleMode</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current toggle mode.
<br/><ul>
<b>Return:</b> the current toggle mode.
<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/>
<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">_availlable</span>);</pre>
<br/>
<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/>
<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> <a href="ewol__DrawProperty.html" class="code-type">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</span>);</pre>
<br/>
<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__event__Input.html" class="code-type">ewol::event::Input</a> & <span class="code-argument">_event</span>);</pre>
<br/>
<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__event__Entry.html" class="code-type">ewol::event::Entry</a> & <span class="code-argument">_event</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//exml__Element.html" class="code-type">exml::Element</a> * <span class="code-argument">_node</span>);</pre>
<br/>
<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/>
<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/>
<br/>
<hr/>
<h3><a id="onSetConfig">onSetConfig</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">onSetConfig</span>(<span class="code-storage-keyword">const</span> <a href="ewol__object__Config.html" class="code-type">ewol::object::Config</a> & <span class="code-argument">_conf</span>);</pre>
<br/>
<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="changeStatusIn">changeStatusIn</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">changeStatusIn</span>(<span class="code-type">int32_t</span> <span class="code-argument">_newStatusId</span>);</pre>
<br/>
internal system to change the property of the current status
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newStatusId</span> new state
<br/></ul>
<br/>
<hr/>
<h3><a id="CheckStatus">CheckStatus</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">CheckStatus</span>(<span class="code-type">void</span>);</pre>
<br/>
update the status with the internal satte of the button ...
<br/><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__event__Time.html" class="code-type">ewol::event::Time</a> & <span class="code-argument">_event</span>);</pre>
<br/>
<br/>
<hr/>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink