1387 lines
84 KiB
HTML
1387 lines
84 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>AceButton: ace_button::ButtonConfig Class Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">AceButton
|
||
|
|
 <span id="projectnumber">1.3.3</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><b>ace_button</b></li><li class="navelem"><a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-types">Public Types</a> |
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="classace__button_1_1ButtonConfig-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">ace_button::ButtonConfig Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class that defines the timing parameters and event handler of an <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> or a group of <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> instances.
|
||
|
|
<a href="classace__button_1_1ButtonConfig.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for ace_button::ButtonConfig:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classace__button_1_1ButtonConfig__inherit__graph.png" border="0" usemap="#ace__button_1_1ButtonConfig_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="ace__button_1_1ButtonConfig_inherit__map" id="ace__button_1_1ButtonConfig_inherit__map">
|
||
|
|
<area shape="rect" id="node2" href="classace__button_1_1AdjustableButtonConfig.html" title="A subclass of ButtonConfig which allows the user to override the varous timing parameters of ButtonCo..." alt="" coords="5,80,199,121"/>
|
||
|
|
</map>
|
||
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
||
|
|
Public Types</h2></td></tr>
|
||
|
|
<tr class="memitem:a1c7c7bfc42738278330243dfc43f23eb"><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a></td></tr>
|
||
|
|
<tr class="memdesc:a1c7c7bfc42738278330243dfc43f23eb"><td class="mdescLeft"> </td><td class="mdescRight">Type of the feature flag. <a href="#a1c7c7bfc42738278330243dfc43f23eb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a1c7c7bfc42738278330243dfc43f23eb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6d9db3c7b221b474c3cfd8fca5f4ba1e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">EventHandler</a>) (<a class="el" href="classace__button_1_1AceButton.html">AceButton</a> *button, uint8_t eventType, uint8_t buttonState)</td></tr>
|
||
|
|
<tr class="memdesc:a6d9db3c7b221b474c3cfd8fca5f4ba1e"><td class="mdescLeft"> </td><td class="mdescRight">The event handler signature. <a href="#a6d9db3c7b221b474c3cfd8fca5f4ba1e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a6d9db3c7b221b474c3cfd8fca5f4ba1e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a66924aac157a81cc54a9776fb975893a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a66924aac157a81cc54a9776fb975893a">ButtonConfig</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a66924aac157a81cc54a9776fb975893a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a66924aac157a81cc54a9776fb975893a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a66924aac157a81cc54a9776fb975893a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad7be58d0fe0b242f78f15319d201a565"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ad7be58d0fe0b242f78f15319d201a565">getDebounceDelay</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ad7be58d0fe0b242f78f15319d201a565"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds to wait for debouncing. <a href="#ad7be58d0fe0b242f78f15319d201a565">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ad7be58d0fe0b242f78f15319d201a565"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a19db203ce87dc2cafb2cab6ba124387a"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a19db203ce87dc2cafb2cab6ba124387a">getClickDelay</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a19db203ce87dc2cafb2cab6ba124387a"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds to wait for a possible click. <a href="#a19db203ce87dc2cafb2cab6ba124387a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a19db203ce87dc2cafb2cab6ba124387a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5ba500367e03c36f39225a5858e110e6"><td class="memItemLeft" align="right" valign="top"><a id="a5ba500367e03c36f39225a5858e110e6"></a>
|
||
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a5ba500367e03c36f39225a5858e110e6">getDoubleClickDelay</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a5ba500367e03c36f39225a5858e110e6"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds between the first and second click to register as a double-click. <br /></td></tr>
|
||
|
|
<tr class="separator:a5ba500367e03c36f39225a5858e110e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a46d4213a827a94bf82ba99a9c2e59531"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a46d4213a827a94bf82ba99a9c2e59531">getLongPressDelay</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a46d4213a827a94bf82ba99a9c2e59531"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds for a long press event. <a href="#a46d4213a827a94bf82ba99a9c2e59531">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a46d4213a827a94bf82ba99a9c2e59531"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad85c75d2a2dd200552a181fb154d5fd2"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ad85c75d2a2dd200552a181fb154d5fd2">getRepeatPressDelay</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ad85c75d2a2dd200552a181fb154d5fd2"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds that a button needs to be Pressed down before the start of the sequence of RepeatPressed events. <a href="#ad85c75d2a2dd200552a181fb154d5fd2">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ad85c75d2a2dd200552a181fb154d5fd2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aec4a97a1a1306b9ff12f1cdf44515c43"><td class="memItemLeft" align="right" valign="top"><a id="aec4a97a1a1306b9ff12f1cdf44515c43"></a>
|
||
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aec4a97a1a1306b9ff12f1cdf44515c43">getRepeatPressInterval</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:aec4a97a1a1306b9ff12f1cdf44515c43"><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds between two successive RepeatPressed events. <br /></td></tr>
|
||
|
|
<tr class="separator:aec4a97a1a1306b9ff12f1cdf44515c43"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9860d2c8a6ab33d40ea126b02d168cab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a9860d2c8a6ab33d40ea126b02d168cab">setDebounceDelay</a> (uint16_t debounceDelay)</td></tr>
|
||
|
|
<tr class="memdesc:a9860d2c8a6ab33d40ea126b02d168cab"><td class="mdescLeft"> </td><td class="mdescRight">Set the debounceDelay. <a href="#a9860d2c8a6ab33d40ea126b02d168cab">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a9860d2c8a6ab33d40ea126b02d168cab"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aef65e12128997c46bc2754a988b98f14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aef65e12128997c46bc2754a988b98f14">setClickDelay</a> (uint16_t clickDelay)</td></tr>
|
||
|
|
<tr class="memdesc:aef65e12128997c46bc2754a988b98f14"><td class="mdescLeft"> </td><td class="mdescRight">Set the clickDelay. <a href="#aef65e12128997c46bc2754a988b98f14">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aef65e12128997c46bc2754a988b98f14"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a367a809017e1d633a5cf6b117981d579"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a367a809017e1d633a5cf6b117981d579">setDoubleClickDelay</a> (uint16_t doubleClickDelay)</td></tr>
|
||
|
|
<tr class="memdesc:a367a809017e1d633a5cf6b117981d579"><td class="mdescLeft"> </td><td class="mdescRight">Set the doubleClickDelay. <a href="#a367a809017e1d633a5cf6b117981d579">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a367a809017e1d633a5cf6b117981d579"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7d90d39aeddacb5abc9d8741611d7c4a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a7d90d39aeddacb5abc9d8741611d7c4a">setLongPressDelay</a> (uint16_t longPressDelay)</td></tr>
|
||
|
|
<tr class="memdesc:a7d90d39aeddacb5abc9d8741611d7c4a"><td class="mdescLeft"> </td><td class="mdescRight">Set the longPressDelay. <a href="#a7d90d39aeddacb5abc9d8741611d7c4a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a7d90d39aeddacb5abc9d8741611d7c4a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af813c969eddd884e9fa83b334a59a0a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#af813c969eddd884e9fa83b334a59a0a5">setRepeatPressDelay</a> (uint16_t repeatPressDelay)</td></tr>
|
||
|
|
<tr class="memdesc:af813c969eddd884e9fa83b334a59a0a5"><td class="mdescLeft"> </td><td class="mdescRight">Set the repeatPressDelay. <a href="#af813c969eddd884e9fa83b334a59a0a5">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af813c969eddd884e9fa83b334a59a0a5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa1b1217e0042512fc8d9b6544536aed3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aa1b1217e0042512fc8d9b6544536aed3">setRepeatPressInterval</a> (uint16_t repeatPressInterval)</td></tr>
|
||
|
|
<tr class="memdesc:aa1b1217e0042512fc8d9b6544536aed3"><td class="mdescLeft"> </td><td class="mdescRight">Set the repeatPressInterval. <a href="#aa1b1217e0042512fc8d9b6544536aed3">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aa1b1217e0042512fc8d9b6544536aed3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a440271e22d5e7e161cdcb3b73f092111"><td class="memItemLeft" align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a440271e22d5e7e161cdcb3b73f092111">getClock</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a440271e22d5e7e161cdcb3b73f092111"><td class="mdescLeft"> </td><td class="mdescRight">Return the milliseconds of the internal clock. <a href="#a440271e22d5e7e161cdcb3b73f092111">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a440271e22d5e7e161cdcb3b73f092111"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8a74d1a1c082bfb0e4ddf55e67d3ac2d"><td class="memItemLeft" align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a8a74d1a1c082bfb0e4ddf55e67d3ac2d">getClockMicros</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a8a74d1a1c082bfb0e4ddf55e67d3ac2d"><td class="mdescLeft"> </td><td class="mdescRight">Return the microseconds of the internal clock. <a href="#a8a74d1a1c082bfb0e4ddf55e67d3ac2d">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a8a74d1a1c082bfb0e4ddf55e67d3ac2d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5dab877bf124bfdf5a5eb703ca123027"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a5dab877bf124bfdf5a5eb703ca123027">readButton</a> (uint8_t pin)</td></tr>
|
||
|
|
<tr class="memdesc:a5dab877bf124bfdf5a5eb703ca123027"><td class="mdescLeft"> </td><td class="mdescRight">Return the HIGH or LOW state of the button. <a href="#a5dab877bf124bfdf5a5eb703ca123027">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a5dab877bf124bfdf5a5eb703ca123027"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aae51c7a2986eafd400784cdbe6bb1815"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aae51c7a2986eafd400784cdbe6bb1815">isFeature</a> (<a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> features) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:aae51c7a2986eafd400784cdbe6bb1815"><td class="mdescLeft"> </td><td class="mdescRight">Check if the given features are enabled. <a href="#aae51c7a2986eafd400784cdbe6bb1815">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aae51c7a2986eafd400784cdbe6bb1815"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aac1c9029b1cf9aa793060d372fc09a1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aac1c9029b1cf9aa793060d372fc09a1a">setFeature</a> (<a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> features) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:aac1c9029b1cf9aa793060d372fc09a1a"><td class="mdescLeft"> </td><td class="mdescRight">Enable the given features. <a href="#aac1c9029b1cf9aa793060d372fc09a1a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aac1c9029b1cf9aa793060d372fc09a1a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac782903e4a60924db3d17c00accc7f3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ac782903e4a60924db3d17c00accc7f3b">clearFeature</a> (<a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> features) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:ac782903e4a60924db3d17c00accc7f3b"><td class="mdescLeft"> </td><td class="mdescRight">Disable the given features. <a href="#ac782903e4a60924db3d17c00accc7f3b">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ac782903e4a60924db3d17c00accc7f3b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8fc32804ba102f61ba97bcc5f4fe8448"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">EventHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a8fc32804ba102f61ba97bcc5f4fe8448">getEventHandler</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a8fc32804ba102f61ba97bcc5f4fe8448"><td class="mdescLeft"> </td><td class="mdescRight">Return the eventHandler. <a href="#a8fc32804ba102f61ba97bcc5f4fe8448">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a8fc32804ba102f61ba97bcc5f4fe8448"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5d228f08e9943fd4ab90caab39ef80be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a5d228f08e9943fd4ab90caab39ef80be">setEventHandler</a> (<a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">EventHandler</a> eventHandler) ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:a5d228f08e9943fd4ab90caab39ef80be"><td class="mdescLeft"> </td><td class="mdescRight">Install the event handler. <a href="#a5d228f08e9943fd4ab90caab39ef80be">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a5d228f08e9943fd4ab90caab39ef80be"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a16d7dbbe1bb075018378e463cd8106de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a16d7dbbe1bb075018378e463cd8106de">setTimingStats</a> (<a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a> *timingStats)</td></tr>
|
||
|
|
<tr class="memdesc:a16d7dbbe1bb075018378e463cd8106de"><td class="mdescLeft"> </td><td class="mdescRight">Set the timing stats object. <a href="#a16d7dbbe1bb075018378e463cd8106de">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a16d7dbbe1bb075018378e463cd8106de"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aff7101f2fe0f0c3bba67924b01e9d493"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#aff7101f2fe0f0c3bba67924b01e9d493">getTimingStats</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:aff7101f2fe0f0c3bba67924b01e9d493"><td class="mdescLeft"> </td><td class="mdescRight">Get the timing stats. <a href="#aff7101f2fe0f0c3bba67924b01e9d493">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aff7101f2fe0f0c3bba67924b01e9d493"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ab780f081ef691b48deb5182d206a4b9d"><td class="memItemLeft" align="right" valign="top"><a id="ab780f081ef691b48deb5182d206a4b9d"></a>
|
||
|
|
static <a class="el" href="classace__button_1_1ButtonConfig.html">ButtonConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ab780f081ef691b48deb5182d206a4b9d">getSystemButtonConfig</a> () ACE_BUTTON_INLINE</td></tr>
|
||
|
|
<tr class="memdesc:ab780f081ef691b48deb5182d206a4b9d"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the singleton instance of the <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> which is attached to all <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> instances by default. <br /></td></tr>
|
||
|
|
<tr class="separator:ab780f081ef691b48deb5182d206a4b9d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||
|
|
Static Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a8fbe63588107a1375d05911d27df3ad8"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a8fbe63588107a1375d05911d27df3ad8">kDebounceDelay</a> = 20</td></tr>
|
||
|
|
<tr class="memdesc:a8fbe63588107a1375d05911d27df3ad8"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#ad7be58d0fe0b242f78f15319d201a565" title="Milliseconds to wait for debouncing. ">getDebounceDelay()</a>. <a href="#a8fbe63588107a1375d05911d27df3ad8">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a8fbe63588107a1375d05911d27df3ad8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5691e38564dae63592d22abf74fb15f3"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a5691e38564dae63592d22abf74fb15f3">kClickDelay</a> = 200</td></tr>
|
||
|
|
<tr class="memdesc:a5691e38564dae63592d22abf74fb15f3"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a19db203ce87dc2cafb2cab6ba124387a" title="Milliseconds to wait for a possible click. ">getClickDelay()</a>. <a href="#a5691e38564dae63592d22abf74fb15f3">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a5691e38564dae63592d22abf74fb15f3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af0a0d503f3396acef6a84aca4390fd6a"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#af0a0d503f3396acef6a84aca4390fd6a">kDoubleClickDelay</a> = 400</td></tr>
|
||
|
|
<tr class="memdesc:af0a0d503f3396acef6a84aca4390fd6a"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a5ba500367e03c36f39225a5858e110e6" title="Milliseconds between the first and second click to register as a double-click. ">getDoubleClickDelay()</a>. <a href="#af0a0d503f3396acef6a84aca4390fd6a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af0a0d503f3396acef6a84aca4390fd6a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a60bf588a2c067a561887eadf18cedccd"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a60bf588a2c067a561887eadf18cedccd">kLongPressDelay</a> = 1000</td></tr>
|
||
|
|
<tr class="memdesc:a60bf588a2c067a561887eadf18cedccd"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a46d4213a827a94bf82ba99a9c2e59531" title="Milliseconds for a long press event. ">getLongPressDelay()</a>. <a href="#a60bf588a2c067a561887eadf18cedccd">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a60bf588a2c067a561887eadf18cedccd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3d20bc5800532085fd046fc64b80ae9f"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a3d20bc5800532085fd046fc64b80ae9f">kRepeatPressDelay</a> = 1000</td></tr>
|
||
|
|
<tr class="memdesc:a3d20bc5800532085fd046fc64b80ae9f"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#ad85c75d2a2dd200552a181fb154d5fd2" title="Milliseconds that a button needs to be Pressed down before the start of the sequence of RepeatPressed...">getRepeatPressDelay()</a>. <a href="#a3d20bc5800532085fd046fc64b80ae9f">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a3d20bc5800532085fd046fc64b80ae9f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a218c1aa09b45ea2fe6884e3af3a18310"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a218c1aa09b45ea2fe6884e3af3a18310">kRepeatPressInterval</a> = 200</td></tr>
|
||
|
|
<tr class="memdesc:a218c1aa09b45ea2fe6884e3af3a18310"><td class="mdescLeft"> </td><td class="mdescRight">Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#aec4a97a1a1306b9ff12f1cdf44515c43" title="Milliseconds between two successive RepeatPressed events. ">getRepeatPressInterval()</a>. <a href="#a218c1aa09b45ea2fe6884e3af3a18310">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a218c1aa09b45ea2fe6884e3af3a18310"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac662555100416c4843c6ee5156699c56"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ac662555100416c4843c6ee5156699c56">kFeatureClick</a> = 0x01</td></tr>
|
||
|
|
<tr class="memdesc:ac662555100416c4843c6ee5156699c56"><td class="mdescLeft"> </td><td class="mdescRight">Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305" title="Button was clicked (Pressed and Released within ButtonConfig::getClickDelay()). ">AceButton::kEventClicked</a> event. <a href="#ac662555100416c4843c6ee5156699c56">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ac662555100416c4843c6ee5156699c56"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a638943c127dd60288a83e83260825d01"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a638943c127dd60288a83e83260825d01">kFeatureDoubleClick</a> = 0x02</td></tr>
|
||
|
|
<tr class="memdesc:a638943c127dd60288a83e83260825d01"><td class="mdescLeft"> </td><td class="mdescRight">Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b" title="Button was double-clicked. ">AceButton::kEventDoubleClicked</a> event. <a href="#a638943c127dd60288a83e83260825d01">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a638943c127dd60288a83e83260825d01"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4d175560047a4ca245186fb26fa413f2"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a4d175560047a4ca245186fb26fa413f2">kFeatureLongPress</a> = 0x04</td></tr>
|
||
|
|
<tr class="memdesc:a4d175560047a4ca245186fb26fa413f2"><td class="mdescLeft"> </td><td class="mdescRight">Flag to activate the AceButton::kEventLongPress event. <a href="#a4d175560047a4ca245186fb26fa413f2">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a4d175560047a4ca245186fb26fa413f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac9b941ca87f0eeb899ed503481439c92"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#ac9b941ca87f0eeb899ed503481439c92">kFeatureRepeatPress</a> = 0x08</td></tr>
|
||
|
|
<tr class="memdesc:ac9b941ca87f0eeb899ed503481439c92"><td class="mdescLeft"> </td><td class="mdescRight">Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9" title="Button was held down and auto generated multiple presses. ">AceButton::kEventRepeatPressed</a> event. <a href="#ac9b941ca87f0eeb899ed503481439c92">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ac9b941ca87f0eeb899ed503481439c92"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a57327066d135bcc99c4a68b55fca162e"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a57327066d135bcc99c4a68b55fca162e">kFeatureSuppressAfterClick</a> = 0x10</td></tr>
|
||
|
|
<tr class="memdesc:a57327066d135bcc99c4a68b55fca162e"><td class="mdescLeft"> </td><td class="mdescRight">Flag to suppress kEventReleased after a kEventClicked. <a href="#a57327066d135bcc99c4a68b55fca162e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a57327066d135bcc99c4a68b55fca162e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7642e16b2cc8dd0136312054b1da8f9e"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a7642e16b2cc8dd0136312054b1da8f9e">kFeatureSuppressAfterDoubleClick</a> = 0x20</td></tr>
|
||
|
|
<tr class="memdesc:a7642e16b2cc8dd0136312054b1da8f9e"><td class="mdescLeft"> </td><td class="mdescRight">Flag to suppress kEventReleased after a kEventDoubleClicked. <a href="#a7642e16b2cc8dd0136312054b1da8f9e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a7642e16b2cc8dd0136312054b1da8f9e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a15b8e90b1ffe01009a1d7dd18b5b6aae"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a15b8e90b1ffe01009a1d7dd18b5b6aae">kFeatureSuppressAfterLongPress</a> = 0x40</td></tr>
|
||
|
|
<tr class="memdesc:a15b8e90b1ffe01009a1d7dd18b5b6aae"><td class="mdescLeft"> </td><td class="mdescRight">Flag to suppress kEventReleased after a kEventLongPressed. <a href="#a15b8e90b1ffe01009a1d7dd18b5b6aae">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a15b8e90b1ffe01009a1d7dd18b5b6aae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6b43b591ba53d360e787bf780af0abbc"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a6b43b591ba53d360e787bf780af0abbc">kFeatureSuppressAfterRepeatPress</a> = 0x80</td></tr>
|
||
|
|
<tr class="memdesc:a6b43b591ba53d360e787bf780af0abbc"><td class="mdescLeft"> </td><td class="mdescRight">Flag to suppress kEventReleased after a kEventRepeatPressed. <a href="#a6b43b591ba53d360e787bf780af0abbc">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a6b43b591ba53d360e787bf780af0abbc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a80d621dbcf533c9bb91a111b8fec2c53"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a80d621dbcf533c9bb91a111b8fec2c53">kFeatureSuppressClickBeforeDoubleClick</a> = 0x100</td></tr>
|
||
|
|
<tr class="memdesc:a80d621dbcf533c9bb91a111b8fec2c53"><td class="mdescLeft"> </td><td class="mdescRight">Flag to suppress kEventClicked before a kEventDoubleClicked. <a href="#a80d621dbcf533c9bb91a111b8fec2c53">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a80d621dbcf533c9bb91a111b8fec2c53"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:abfd736234ae852f22894c7aceb4e534e"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#abfd736234ae852f22894c7aceb4e534e">kFeatureSuppressAll</a></td></tr>
|
||
|
|
<tr class="memdesc:abfd736234ae852f22894c7aceb4e534e"><td class="mdescLeft"> </td><td class="mdescRight">Convenience flag to suppress all suppressions. <a href="#abfd736234ae852f22894c7aceb4e534e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:abfd736234ae852f22894c7aceb4e534e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
||
|
|
Protected Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a86f8f6b62825258e477e0a41846e0223"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1ButtonConfig.html#a86f8f6b62825258e477e0a41846e0223">init</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a86f8f6b62825258e477e0a41846e0223"><td class="mdescLeft"> </td><td class="mdescRight">Initialize to its pristine state, except for the EventHandler which is unchanged. <a href="#a86f8f6b62825258e477e0a41846e0223">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a86f8f6b62825258e477e0a41846e0223"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class that defines the timing parameters and event handler of an <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> or a group of <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> instances. </p>
|
||
|
|
<p>It is assumed that in many cases, a group of multiple buttons will need to be assigned the same configuration parameters. For example, various timing delays and the EventHandler. Instead of storing these parameters in each instance of <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> (which consumes static memory), we save space by collecting them into a separate <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> class. Each <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> instance contains a pointer to an instance of <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a>, and an instance of <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> will be shared among multiple AceButtons.</p>
|
||
|
|
<p>Various timing parameters are given default values. They can be overridden by the user.</p>
|
||
|
|
<p>A single default "System" <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> instance is created automatically and can be accessed using the ButtConfig::getSystemButtonConfig() static method. For convenience and ease of use, every instance of <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> is attached to this "System" <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> by default. The client code can override this association by attaching another <a class="el" href="classace__button_1_1ButtonConfig.html" title="Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...">ButtonConfig</a> instance using the AceButton(ButtonConfig*) constuctor (the recommended solution) or the <a class="el" href="classace__button_1_1AceButton.html#abc9d705d1ca4341cf6f9434962b5b5e7" title="Set the ButtonConfig associated with this Button. ">AceButton::setButtonConfig()</a> method. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00060">60</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
||
|
|
<a id="a6d9db3c7b221b474c3cfd8fca5f4ba1e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d9db3c7b221b474c3cfd8fca5f4ba1e">◆ </a></span>EventHandler</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef void(* ace_button::ButtonConfig::EventHandler) (<a class="el" href="classace__button_1_1AceButton.html">AceButton</a> *button, uint8_t eventType, uint8_t buttonState)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The event handler signature. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">button</td><td>pointer to the <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> that generated the event </td></tr>
|
||
|
|
<tr><td class="paramname">eventType</td><td>the event type which trigger the call </td></tr>
|
||
|
|
<tr><td class="paramname">buttonState</td><td>the state of the button that triggered the event </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00164">164</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a1c7c7bfc42738278330243dfc43f23eb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c7c7bfc42738278330243dfc43f23eb">◆ </a></span>FeatureFlagType</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef uint16_t <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">ace_button::ButtonConfig::FeatureFlagType</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Type of the feature flag. </p>
|
||
|
|
<p>It used to be a uint8_t but got changed to a uint16_t when more than 8 flags were needed. Let's define a typedef to make it easier to change this in the future. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00101">101</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a66924aac157a81cc54a9776fb975893a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66924aac157a81cc54a9776fb975893a">◆ </a></span>ButtonConfig()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">ace_button::ButtonConfig::ButtonConfig </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Constructor. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00168">168</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="ac782903e4a60924db3d17c00accc7f3b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac782903e4a60924db3d17c00accc7f3b">◆ </a></span>clearFeature()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::clearFeature </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td>
|
||
|
|
<td class="paramname"><em>features</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Disable the given features. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00281">281</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a19db203ce87dc2cafb2cab6ba124387a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19db203ce87dc2cafb2cab6ba124387a">◆ </a></span>getClickDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t ace_button::ButtonConfig::getClickDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Milliseconds to wait for a possible click. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00179">179</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a440271e22d5e7e161cdcb3b73f092111"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a440271e22d5e7e161cdcb3b73f092111">◆ </a></span>getClock()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual unsigned long ace_button::ButtonConfig::getClock </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Return the milliseconds of the internal clock. </p>
|
||
|
|
<p>Override to use something other than millis(). The return type is 'unsigned long' instead of uint16_t because that's the return type of millis(). </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00250">250</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8a74d1a1c082bfb0e4ddf55e67d3ac2d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a74d1a1c082bfb0e4ddf55e67d3ac2d">◆ </a></span>getClockMicros()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual unsigned long ace_button::ButtonConfig::getClockMicros </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Return the microseconds of the internal clock. </p>
|
||
|
|
<p>Can be overridden for testing purposes. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00256">256</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad7be58d0fe0b242f78f15319d201a565"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7be58d0fe0b242f78f15319d201a565">◆ </a></span>getDebounceDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t ace_button::ButtonConfig::getDebounceDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Milliseconds to wait for debouncing. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00176">176</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8fc32804ba102f61ba97bcc5f4fe8448"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fc32804ba102f61ba97bcc5f4fe8448">◆ </a></span>getEventHandler()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">EventHandler</a> ace_button::ButtonConfig::getEventHandler </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Return the eventHandler. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00288">288</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a46d4213a827a94bf82ba99a9c2e59531"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46d4213a827a94bf82ba99a9c2e59531">◆ </a></span>getLongPressDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t ace_button::ButtonConfig::getLongPressDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Milliseconds for a long press event. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00190">190</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad85c75d2a2dd200552a181fb154d5fd2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad85c75d2a2dd200552a181fb154d5fd2">◆ </a></span>getRepeatPressDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t ace_button::ButtonConfig::getRepeatPressDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Milliseconds that a button needs to be Pressed down before the start of the sequence of RepeatPressed events. </p>
|
||
|
|
<p>The first event will fire as soon as this delay has passed. Subsequent events will fire after <a class="el" href="classace__button_1_1ButtonConfig.html#aec4a97a1a1306b9ff12f1cdf44515c43" title="Milliseconds between two successive RepeatPressed events. ">getRepeatPressInterval()</a> time. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00200">200</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aff7101f2fe0f0c3bba67924b01e9d493"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff7101f2fe0f0c3bba67924b01e9d493">◆ </a></span>getTimingStats()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a>* ace_button::ButtonConfig::getTimingStats </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the timing stats. </p>
|
||
|
|
<p>Can return nullptr. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00308">308</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a86f8f6b62825258e477e0a41846e0223"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86f8f6b62825258e477e0a41846e0223">◆ </a></span>init()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void ace_button::ButtonConfig::init </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Initialize to its pristine state, except for the EventHandler which is unchanged. </p>
|
||
|
|
<p>This is intended mostly for testing purposes. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00323">323</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aae51c7a2986eafd400784cdbe6bb1815"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae51c7a2986eafd400784cdbe6bb1815">◆ </a></span>isFeature()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool ace_button::ButtonConfig::isFeature </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td>
|
||
|
|
<td class="paramname"><em>features</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check if the given features are enabled. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00271">271</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5dab877bf124bfdf5a5eb703ca123027"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5dab877bf124bfdf5a5eb703ca123027">◆ </a></span>readButton()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual int ace_button::ButtonConfig::readButton </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8_t </td>
|
||
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Return the HIGH or LOW state of the button. </p>
|
||
|
|
<p>Override to use something other than digitalRead(). The return type is 'int' instead of uint16_t because that's the return type of digitalRead(). </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00263">263</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aef65e12128997c46bc2754a988b98f14"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aef65e12128997c46bc2754a988b98f14">◆ </a></span>setClickDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setClickDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>clickDelay</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the clickDelay. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00217">217</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9860d2c8a6ab33d40ea126b02d168cab"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9860d2c8a6ab33d40ea126b02d168cab">◆ </a></span>setDebounceDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setDebounceDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>debounceDelay</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the debounceDelay. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00212">212</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a367a809017e1d633a5cf6b117981d579"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a367a809017e1d633a5cf6b117981d579">◆ </a></span>setDoubleClickDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setDoubleClickDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>doubleClickDelay</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the doubleClickDelay. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00222">222</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5d228f08e9943fd4ab90caab39ef80be"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d228f08e9943fd4ab90caab39ef80be">◆ </a></span>setEventHandler()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setEventHandler </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html#a6d9db3c7b221b474c3cfd8fca5f4ba1e">EventHandler</a> </td>
|
||
|
|
<td class="paramname"><em>eventHandler</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Install the event handler. </p>
|
||
|
|
<p>The event handler must be defined for the <a class="el" href="classace__button_1_1AceButton.html" title="An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...">AceButton</a> to be useful. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00296">296</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aac1c9029b1cf9aa793060d372fc09a1a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac1c9029b1cf9aa793060d372fc09a1a">◆ </a></span>setFeature()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setFeature </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> </td>
|
||
|
|
<td class="paramname"><em>features</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Enable the given features. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00276">276</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7d90d39aeddacb5abc9d8741611d7c4a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d90d39aeddacb5abc9d8741611d7c4a">◆ </a></span>setLongPressDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setLongPressDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>longPressDelay</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the longPressDelay. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00227">227</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af813c969eddd884e9fa83b334a59a0a5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af813c969eddd884e9fa83b334a59a0a5">◆ </a></span>setRepeatPressDelay()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setRepeatPressDelay </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>repeatPressDelay</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the repeatPressDelay. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00232">232</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa1b1217e0042512fc8d9b6544536aed3"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa1b1217e0042512fc8d9b6544536aed3">◆ </a></span>setRepeatPressInterval()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setRepeatPressInterval </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>repeatPressInterval</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the repeatPressInterval. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00237">237</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a16d7dbbe1bb075018378e463cd8106de"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16d7dbbe1bb075018378e463cd8106de">◆ </a></span>setTimingStats()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void ace_button::ButtonConfig::setTimingStats </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a> * </td>
|
||
|
|
<td class="paramname"><em>timingStats</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the timing stats object. </p>
|
||
|
|
<p>The timingStats can be nullptr. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00303">303</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a id="a5691e38564dae63592d22abf74fb15f3"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5691e38564dae63592d22abf74fb15f3">◆ </a></span>kClickDelay</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kClickDelay = 200</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a19db203ce87dc2cafb2cab6ba124387a" title="Milliseconds to wait for a possible click. ">getClickDelay()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00080">80</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8fbe63588107a1375d05911d27df3ad8"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fbe63588107a1375d05911d27df3ad8">◆ </a></span>kDebounceDelay</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kDebounceDelay = 20</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#ad7be58d0fe0b242f78f15319d201a565" title="Milliseconds to wait for debouncing. ">getDebounceDelay()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00077">77</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af0a0d503f3396acef6a84aca4390fd6a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0a0d503f3396acef6a84aca4390fd6a">◆ </a></span>kDoubleClickDelay</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kDoubleClickDelay = 400</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a5ba500367e03c36f39225a5858e110e6" title="Milliseconds between the first and second click to register as a double-click. ">getDoubleClickDelay()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00083">83</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac662555100416c4843c6ee5156699c56"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac662555100416c4843c6ee5156699c56">◆ </a></span>kFeatureClick</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureClick = 0x01</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a21797e5e069da3f7bba42b40ab3a7305" title="Button was clicked (Pressed and Released within ButtonConfig::getClickDelay()). ">AceButton::kEventClicked</a> event. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00104">104</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a638943c127dd60288a83e83260825d01"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a638943c127dd60288a83e83260825d01">◆ </a></span>kFeatureDoubleClick</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureDoubleClick = 0x02</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a0c63f30106e4688425ba37d8f7a9546b" title="Button was double-clicked. ">AceButton::kEventDoubleClicked</a> event. </p>
|
||
|
|
<p>Activating this automatically activates kEventClicked since there is no double-click without a click. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00111">111</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a4d175560047a4ca245186fb26fa413f2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d175560047a4ca245186fb26fa413f2">◆ </a></span>kFeatureLongPress</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureLongPress = 0x04</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to activate the AceButton::kEventLongPress event. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00114">114</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac9b941ca87f0eeb899ed503481439c92"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9b941ca87f0eeb899ed503481439c92">◆ </a></span>kFeatureRepeatPress</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureRepeatPress = 0x08</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to activate the <a class="el" href="classace__button_1_1AceButton.html#a9c4195cb128da40677ea223eb81743c9" title="Button was held down and auto generated multiple presses. ">AceButton::kEventRepeatPressed</a> event. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00117">117</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a57327066d135bcc99c4a68b55fca162e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57327066d135bcc99c4a68b55fca162e">◆ </a></span>kFeatureSuppressAfterClick</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressAfterClick = 0x10</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to suppress kEventReleased after a kEventClicked. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00120">120</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7642e16b2cc8dd0136312054b1da8f9e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7642e16b2cc8dd0136312054b1da8f9e">◆ </a></span>kFeatureSuppressAfterDoubleClick</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressAfterDoubleClick = 0x20</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to suppress kEventReleased after a kEventDoubleClicked. </p>
|
||
|
|
<p>A kEventClicked is <em>always</em> suppressed after a kEventDoubleClicked to prevent generating 2 double-clicks if the user performed a triple-click. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00127">127</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a15b8e90b1ffe01009a1d7dd18b5b6aae"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15b8e90b1ffe01009a1d7dd18b5b6aae">◆ </a></span>kFeatureSuppressAfterLongPress</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressAfterLongPress = 0x40</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to suppress kEventReleased after a kEventLongPressed. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00130">130</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6b43b591ba53d360e787bf780af0abbc"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b43b591ba53d360e787bf780af0abbc">◆ </a></span>kFeatureSuppressAfterRepeatPress</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressAfterRepeatPress = 0x80</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to suppress kEventReleased after a kEventRepeatPressed. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00133">133</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="abfd736234ae852f22894c7aceb4e534e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abfd736234ae852f22894c7aceb4e534e">◆ </a></span>kFeatureSuppressAll</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressAll</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<b>Initial value:</b><div class="fragment"><div class="line">=</div><div class="line"> (<a class="code" href="classace__button_1_1ButtonConfig.html#a57327066d135bcc99c4a68b55fca162e">kFeatureSuppressAfterClick</a> |</div><div class="line"> <a class="code" href="classace__button_1_1ButtonConfig.html#a7642e16b2cc8dd0136312054b1da8f9e">kFeatureSuppressAfterDoubleClick</a> |</div><div class="line"> <a class="code" href="classace__button_1_1ButtonConfig.html#a15b8e90b1ffe01009a1d7dd18b5b6aae">kFeatureSuppressAfterLongPress</a> |</div><div class="line"> <a class="code" href="classace__button_1_1ButtonConfig.html#a6b43b591ba53d360e787bf780af0abbc">kFeatureSuppressAfterRepeatPress</a> |</div><div class="line"> <a class="code" href="classace__button_1_1ButtonConfig.html#a80d621dbcf533c9bb91a111b8fec2c53">kFeatureSuppressClickBeforeDoubleClick</a>)</div></div><!-- fragment -->
|
||
|
|
<p>Convenience flag to suppress all suppressions. </p>
|
||
|
|
<p>Calling setFeature(kFeatureSuppressAll) suppresses all and clearFeature(kFeatureSuppressAll) clears all suppression. Note however that isFeature(kFeatureSuppressAll) currently means "is ANY feature
|
||
|
|
enabled?" not "are ALL features enabled?". </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00150">150</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a80d621dbcf533c9bb91a111b8fec2c53"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80d621dbcf533c9bb91a111b8fec2c53">◆ </a></span>kFeatureSuppressClickBeforeDoubleClick</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="classace__button_1_1ButtonConfig.html#a1c7c7bfc42738278330243dfc43f23eb">FeatureFlagType</a> ace_button::ButtonConfig::kFeatureSuppressClickBeforeDoubleClick = 0x100</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Flag to suppress kEventClicked before a kEventDoubleClicked. </p>
|
||
|
|
<p>This causes the notification of a kEventClicked to be delayed until the delay time of <a class="el" href="classace__button_1_1ButtonConfig.html#a5ba500367e03c36f39225a5858e110e6" title="Milliseconds between the first and second click to register as a double-click. ">getDoubleClickDelay()</a> has passed so that we can determine if there was a kEventDoubleClicked. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00141">141</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a60bf588a2c067a561887eadf18cedccd"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60bf588a2c067a561887eadf18cedccd">◆ </a></span>kLongPressDelay</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kLongPressDelay = 1000</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#a46d4213a827a94bf82ba99a9c2e59531" title="Milliseconds for a long press event. ">getLongPressDelay()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00086">86</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a3d20bc5800532085fd046fc64b80ae9f"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d20bc5800532085fd046fc64b80ae9f">◆ </a></span>kRepeatPressDelay</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kRepeatPressDelay = 1000</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#ad85c75d2a2dd200552a181fb154d5fd2" title="Milliseconds that a button needs to be Pressed down before the start of the sequence of RepeatPressed...">getRepeatPressDelay()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00089">89</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a218c1aa09b45ea2fe6884e3af3a18310"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a218c1aa09b45ea2fe6884e3af3a18310">◆ </a></span>kRepeatPressInterval</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const uint16_t ace_button::ButtonConfig::kRepeatPressInterval = 200</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Default value returned by <a class="el" href="classace__button_1_1ButtonConfig.html#aec4a97a1a1306b9ff12f1cdf44515c43" title="Milliseconds between two successive RepeatPressed events. ">getRepeatPressInterval()</a>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="ace__button_2ButtonConfig_8h_source.html#l00092">92</a> of file <a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="ace__button_2ButtonConfig_8h_source.html">ButtonConfig.h</a></li>
|
||
|
|
<li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="ButtonConfig_8cpp_source.html">ButtonConfig.cpp</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.13
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|