diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_keyboard_button.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_keyboard_button.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_keyboard_button.html b/docs/class_tg_bot_1_1_keyboard_button.html new file mode 100644 index 0000000..a28b7e9 --- /dev/null +++ b/docs/class_tg_bot_1_1_keyboard_button.html @@ -0,0 +1,195 @@ +<!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>tgbot-cpp: TgBot::KeyboardButton 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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">tgbot-cpp + </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> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_tg_bot_1_1_keyboard_button.html','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_keyboard_button-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::KeyboardButton Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>></code></p> +<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:afa66915e5a8d58dbd7276265f00b0bcd"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_keyboard_button.html">KeyboardButton</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_keyboard_button.html#afa66915e5a8d58dbd7276265f00b0bcd">Ptr</a></td></tr> +<tr class="separator:afa66915e5a8d58dbd7276265f00b0bcd"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:ac9ac8ddd73e27732fcbab7163ff74e2e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_keyboard_button.html#ac9ac8ddd73e27732fcbab7163ff74e2e">text</a></td></tr> +<tr class="separator:ac9ac8ddd73e27732fcbab7163ff74e2e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3e8c6e40ecf3a8f739a12265a89fd381"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_keyboard_button.html#a3e8c6e40ecf3a8f739a12265a89fd381">requestContact</a> = false</td></tr> +<tr class="separator:a3e8c6e40ecf3a8f739a12265a89fd381"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8948e0ca465352d04c44767c25275022"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_keyboard_button.html#a8948e0ca465352d04c44767c25275022">requestLocation</a> = false</td></tr> +<tr class="separator:a8948e0ca465352d04c44767c25275022"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive. </p> + +<p class="definition">Definition at line <a class="el" href="_keyboard_button_8h_source.html#l00019">19</a> of file <a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="afa66915e5a8d58dbd7276265f00b0bcd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afa66915e5a8d58dbd7276265f00b0bcd">◆ </a></span>Ptr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_keyboard_button.html">KeyboardButton</a>> <a class="el" href="class_tg_bot_1_1_keyboard_button.html#afa66915e5a8d58dbd7276265f00b0bcd">TgBot::KeyboardButton::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_keyboard_button_8h_source.html#l00022">22</a> of file <a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a3e8c6e40ecf3a8f739a12265a89fd381"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3e8c6e40ecf3a8f739a12265a89fd381">◆ </a></span>requestContact</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::KeyboardButton::requestContact = false</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only </p> + +<p class="definition">Definition at line <a class="el" href="_keyboard_button_8h_source.html#l00034">34</a> of file <a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>.</p> + +</div> +</div> +<a id="a8948e0ca465352d04c44767c25275022"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8948e0ca465352d04c44767c25275022">◆ </a></span>requestLocation</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::KeyboardButton::requestLocation = false</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only. </p> + +<p class="definition">Definition at line <a class="el" href="_keyboard_button_8h_source.html#l00039">39</a> of file <a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>.</p> + +</div> +</div> +<a id="ac9ac8ddd73e27732fcbab7163ff74e2e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac9ac8ddd73e27732fcbab7163ff74e2e">◆ </a></span>text</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::KeyboardButton::text</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed </p> + +<p class="definition">Definition at line <a class="el" href="_keyboard_button_8h_source.html#l00028">28</a> of file <a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/types/<a class="el" href="_keyboard_button_8h_source.html">KeyboardButton.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_keyboard_button.html">KeyboardButton</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:17 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |