mirror of
https://github.com/adafruit/Adafruit-GFX-Library.git
synced 2026-10-26 22:10:52 +00:00
680 lines
31 KiB
HTML
680 lines
31 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>Adafruit GFX Library: Adafruit_GFX_Button 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">Adafruit GFX Library
|
|
</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_adafruit___g_f_x___button-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Adafruit_GFX_Button Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A simple drawn button UI element.
|
|
<a href="class_adafruit___g_f_x___button.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit___g_f_x_8h_source.html">Adafruit_GFX.h</a>></code></p>
|
|
<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:a2232fef797e2d21f931eeda59d790d09"><td class="memItemLeft" align="right" valign="top"><a id="a2232fef797e2d21f931eeda59d790d09"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a2232fef797e2d21f931eeda59d790d09">Adafruit_GFX_Button</a> (void)</td></tr>
|
|
<tr class="memdesc:a2232fef797e2d21f931eeda59d790d09"><td class="mdescLeft"> </td><td class="mdescRight">Create a simple drawn button UI element. <br /></td></tr>
|
|
<tr class="separator:a2232fef797e2d21f931eeda59d790d09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4f74405e3b4bca3617466cd065fce8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#ab4f74405e3b4bca3617466cd065fce8d">initButton</a> (<a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> *gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, const char *label, uint8_t textsize)</td></tr>
|
|
<tr class="memdesc:ab4f74405e3b4bca3617466cd065fce8d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize button with our desired color/size/settings. <a href="#ab4f74405e3b4bca3617466cd065fce8d">More...</a><br /></td></tr>
|
|
<tr class="separator:ab4f74405e3b4bca3617466cd065fce8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6de979bd52bd967023336a0351ae6623"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a6de979bd52bd967023336a0351ae6623">initButton</a> (<a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> *gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, const char *label, uint8_t textsize_x, uint8_t textsize_y)</td></tr>
|
|
<tr class="memdesc:a6de979bd52bd967023336a0351ae6623"><td class="mdescLeft"> </td><td class="mdescRight">Initialize button with our desired color/size/settings. <a href="#a6de979bd52bd967023336a0351ae6623">More...</a><br /></td></tr>
|
|
<tr class="separator:a6de979bd52bd967023336a0351ae6623"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b5e97e5050459c7444cdec9c9e58475"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a5b5e97e5050459c7444cdec9c9e58475">initButtonUL</a> (<a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> *gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, const char *label, uint8_t textsize)</td></tr>
|
|
<tr class="memdesc:a5b5e97e5050459c7444cdec9c9e58475"><td class="mdescLeft"> </td><td class="mdescRight">Initialize button with our desired color/size/settings, with upper-left coordinates. <a href="#a5b5e97e5050459c7444cdec9c9e58475">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b5e97e5050459c7444cdec9c9e58475"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a938d2ab25ca053999e82f6b2a7dd2631"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a938d2ab25ca053999e82f6b2a7dd2631">initButtonUL</a> (<a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> *gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, const char *label, uint8_t textsize_x, uint8_t textsize_y)</td></tr>
|
|
<tr class="memdesc:a938d2ab25ca053999e82f6b2a7dd2631"><td class="mdescLeft"> </td><td class="mdescRight">Initialize button with our desired color/size/settings, with upper-left coordinates. <a href="#a938d2ab25ca053999e82f6b2a7dd2631">More...</a><br /></td></tr>
|
|
<tr class="separator:a938d2ab25ca053999e82f6b2a7dd2631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60b389bf3ac1546eb379ec09ebc2d16c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a60b389bf3ac1546eb379ec09ebc2d16c">drawButton</a> (bool inverted=false)</td></tr>
|
|
<tr class="memdesc:a60b389bf3ac1546eb379ec09ebc2d16c"><td class="mdescLeft"> </td><td class="mdescRight">Draw the button on the screen. <a href="#a60b389bf3ac1546eb379ec09ebc2d16c">More...</a><br /></td></tr>
|
|
<tr class="separator:a60b389bf3ac1546eb379ec09ebc2d16c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad74992b8c5e0aaf91f1bd80bad29095b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#ad74992b8c5e0aaf91f1bd80bad29095b">contains</a> (int16_t x, int16_t y)</td></tr>
|
|
<tr class="memdesc:ad74992b8c5e0aaf91f1bd80bad29095b"><td class="mdescLeft"> </td><td class="mdescRight">Helper to let us know if a coordinate is within the bounds of the button. <a href="#ad74992b8c5e0aaf91f1bd80bad29095b">More...</a><br /></td></tr>
|
|
<tr class="separator:ad74992b8c5e0aaf91f1bd80bad29095b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a932228d686e6dec88b8b99d03fdb59a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#a932228d686e6dec88b8b99d03fdb59a7">press</a> (bool p)</td></tr>
|
|
<tr class="memdesc:a932228d686e6dec88b8b99d03fdb59a7"><td class="mdescLeft"> </td><td class="mdescRight">Sets button state, should be done by some touch function. <a href="#a932228d686e6dec88b8b99d03fdb59a7">More...</a><br /></td></tr>
|
|
<tr class="separator:a932228d686e6dec88b8b99d03fdb59a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad263405e09f7f2415d6fed2628637c7c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#ad263405e09f7f2415d6fed2628637c7c">justPressed</a> ()</td></tr>
|
|
<tr class="memdesc:ad263405e09f7f2415d6fed2628637c7c"><td class="mdescLeft"> </td><td class="mdescRight">Query whether the button was pressed since we last checked state. <a href="#ad263405e09f7f2415d6fed2628637c7c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad263405e09f7f2415d6fed2628637c7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad3fc2981cbe9dc16dc06a781d8fee90"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#aad3fc2981cbe9dc16dc06a781d8fee90">justReleased</a> ()</td></tr>
|
|
<tr class="memdesc:aad3fc2981cbe9dc16dc06a781d8fee90"><td class="mdescLeft"> </td><td class="mdescRight">Query whether the button was released since we last checked state. <a href="#aad3fc2981cbe9dc16dc06a781d8fee90">More...</a><br /></td></tr>
|
|
<tr class="separator:aad3fc2981cbe9dc16dc06a781d8fee90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfdc75934b4acca801127fae6914fbf8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___g_f_x___button.html#adfdc75934b4acca801127fae6914fbf8">isPressed</a> (void)</td></tr>
|
|
<tr class="memdesc:adfdc75934b4acca801127fae6914fbf8"><td class="mdescLeft"> </td><td class="mdescRight">Query whether the button is currently pressed. <a href="#adfdc75934b4acca801127fae6914fbf8">More...</a><br /></td></tr>
|
|
<tr class="separator:adfdc75934b4acca801127fae6914fbf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A simple drawn button UI element. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab4f74405e3b4bca3617466cd065fce8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4f74405e3b4bca3617466cd065fce8d">◆ </a></span>initButton() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::initButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> * </td>
|
|
<td class="paramname"><em>gfx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>outline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>fill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>textcolor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize button with our desired color/size/settings. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gfx</td><td>Pointer to our display so we can draw to it! </td></tr>
|
|
<tr><td class="paramname">x</td><td>The X coordinate of the center of the button </td></tr>
|
|
<tr><td class="paramname">y</td><td>The Y coordinate of the center of the button </td></tr>
|
|
<tr><td class="paramname">w</td><td>Width of the buttton </td></tr>
|
|
<tr><td class="paramname">h</td><td>Height of the buttton </td></tr>
|
|
<tr><td class="paramname">outline</td><td>Color of the outline (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">fill</td><td>Color of the button fill (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">textcolor</td><td>Color of the button label (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">label</td><td>Ascii string of the text inside the button </td></tr>
|
|
<tr><td class="paramname">textsize</td><td>The font magnification of the label text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6de979bd52bd967023336a0351ae6623"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6de979bd52bd967023336a0351ae6623">◆ </a></span>initButton() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::initButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> * </td>
|
|
<td class="paramname"><em>gfx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>outline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>fill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>textcolor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize_x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize_y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize button with our desired color/size/settings. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gfx</td><td>Pointer to our display so we can draw to it! </td></tr>
|
|
<tr><td class="paramname">x</td><td>The X coordinate of the center of the button </td></tr>
|
|
<tr><td class="paramname">y</td><td>The Y coordinate of the center of the button </td></tr>
|
|
<tr><td class="paramname">w</td><td>Width of the buttton </td></tr>
|
|
<tr><td class="paramname">h</td><td>Height of the buttton </td></tr>
|
|
<tr><td class="paramname">outline</td><td>Color of the outline (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">fill</td><td>Color of the button fill (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">textcolor</td><td>Color of the button label (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">label</td><td>Ascii string of the text inside the button </td></tr>
|
|
<tr><td class="paramname">textsize_x</td><td>The font magnification in X-axis of the label text </td></tr>
|
|
<tr><td class="paramname">textsize_y</td><td>The font magnification in Y-axis of the label text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b5e97e5050459c7444cdec9c9e58475"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b5e97e5050459c7444cdec9c9e58475">◆ </a></span>initButtonUL() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::initButtonUL </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> * </td>
|
|
<td class="paramname"><em>gfx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>x1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>y1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>outline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>fill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>textcolor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize button with our desired color/size/settings, with upper-left coordinates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gfx</td><td>Pointer to our display so we can draw to it! </td></tr>
|
|
<tr><td class="paramname">x1</td><td>The X coordinate of the Upper-Left corner of the button </td></tr>
|
|
<tr><td class="paramname">y1</td><td>The Y coordinate of the Upper-Left corner of the button </td></tr>
|
|
<tr><td class="paramname">w</td><td>Width of the buttton </td></tr>
|
|
<tr><td class="paramname">h</td><td>Height of the buttton </td></tr>
|
|
<tr><td class="paramname">outline</td><td>Color of the outline (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">fill</td><td>Color of the button fill (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">textcolor</td><td>Color of the button label (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">label</td><td>Ascii string of the text inside the button </td></tr>
|
|
<tr><td class="paramname">textsize</td><td>The font magnification of the label text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a938d2ab25ca053999e82f6b2a7dd2631"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a938d2ab25ca053999e82f6b2a7dd2631">◆ </a></span>initButtonUL() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::initButtonUL </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_adafruit___g_f_x.html">Adafruit_GFX</a> * </td>
|
|
<td class="paramname"><em>gfx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>x1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>y1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>outline</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>fill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>textcolor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize_x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>textsize_y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize button with our desired color/size/settings, with upper-left coordinates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gfx</td><td>Pointer to our display so we can draw to it! </td></tr>
|
|
<tr><td class="paramname">x1</td><td>The X coordinate of the Upper-Left corner of the button </td></tr>
|
|
<tr><td class="paramname">y1</td><td>The Y coordinate of the Upper-Left corner of the button </td></tr>
|
|
<tr><td class="paramname">w</td><td>Width of the buttton </td></tr>
|
|
<tr><td class="paramname">h</td><td>Height of the buttton </td></tr>
|
|
<tr><td class="paramname">outline</td><td>Color of the outline (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">fill</td><td>Color of the button fill (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">textcolor</td><td>Color of the button label (16-bit 5-6-5 standard) </td></tr>
|
|
<tr><td class="paramname">label</td><td>Ascii string of the text inside the button </td></tr>
|
|
<tr><td class="paramname">textsize_x</td><td>The font magnification in X-axis of the label text </td></tr>
|
|
<tr><td class="paramname">textsize_y</td><td>The font magnification in Y-axis of the label text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60b389bf3ac1546eb379ec09ebc2d16c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60b389bf3ac1546eb379ec09ebc2d16c">◆ </a></span>drawButton()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::drawButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>inverted</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw the button on the screen. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inverted</td><td>Whether to draw with fill/text swapped to indicate 'pressed' </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad74992b8c5e0aaf91f1bd80bad29095b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad74992b8c5e0aaf91f1bd80bad29095b">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_GFX_Button::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Helper to let us know if a coordinate is within the bounds of the button. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>The X coordinate to check </td></tr>
|
|
<tr><td class="paramname">y</td><td>The Y coordinate to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if within button graphics outline </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a932228d686e6dec88b8b99d03fdb59a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a932228d686e6dec88b8b99d03fdb59a7">◆ </a></span>press()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_GFX_Button::press </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>p</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>Sets button state, should be done by some touch function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p</td><td>True for pressed, false for not. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad263405e09f7f2415d6fed2628637c7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad263405e09f7f2415d6fed2628637c7c">◆ </a></span>justPressed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_GFX_Button::justPressed </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query whether the button was pressed since we last checked state. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if was not-pressed before, now is. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad3fc2981cbe9dc16dc06a781d8fee90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad3fc2981cbe9dc16dc06a781d8fee90">◆ </a></span>justReleased()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_GFX_Button::justReleased </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query whether the button was released since we last checked state. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if was pressed before, now is not. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfdc75934b4acca801127fae6914fbf8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfdc75934b4acca801127fae6914fbf8">◆ </a></span>isPressed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_GFX_Button::isPressed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </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>Query whether the button is currently pressed. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if pressed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_adafruit___g_f_x_8h_source.html">Adafruit_GFX.h</a></li>
|
|
<li>Adafruit_GFX.cpp</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>
|