Docs

author: Oleg Morozenkov <reo7sp@users.noreply.github.com> 2017-01-15 02:33:59 +0300
committer: Oleg Morozenkov <reo7sp@users.noreply.github.com> 2017-01-15 02:33:59 +0300
commit: b22c20c4db8c35eaee99075d055f74697c5805b8 (patch)
tree: b98fed35b212b5fdad9e03699658f769b3295424 /docs/d0/dff
parent: ae77f1220939915953419f232d4fc6441c88f96c (diff)
3 files changed, 200 insertions, 0 deletions
diff --git a/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html
new file mode 100644
index 0000000..e99c05f
--- /dev/null
+++ b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html
@@ -0,0 +1,194 @@
+<!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::ReplyKeyboardRemove 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('d0/dff/class_tg_bot_1_1_reply_keyboard_remove.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> &#124;
+<a href="#pub-attribs">Public Attributes</a> &#124;
+<a href="../../d2/d6e/class_tg_bot_1_1_reply_keyboard_remove-members.html">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">TgBot::ReplyKeyboardRemove Class Reference<div class="ingroups"><a class="el" href="../../d6/d59/group__types.html">Types</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for TgBot::ReplyKeyboardRemove:</div>
+<div class="dyncontent">
+ <div class="center">
+  <img src="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png" usemap="#TgBot::ReplyKeyboardRemove_map" alt=""/>
+  <map id="TgBot::ReplyKeyboardRemove_map" name="TgBot::ReplyKeyboardRemove_map">
+<area href="../../d2/d60/class_tg_bot_1_1_generic_reply.html" alt="TgBot::GenericReply" shape="rect" coords="0,0,182,24"/>
+</map>
+ </div></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:aaa58ef7c177db3a3f46530bfb5fc0148"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr&lt; <a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html">ReplyKeyboardRemove</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#aaa58ef7c177db3a3f46530bfb5fc0148">Ptr</a></td></tr>
+<tr class="separator:aaa58ef7c177db3a3f46530bfb5fc0148"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="inherit_header pub_types_class_tg_bot_1_1_generic_reply"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_tg_bot_1_1_generic_reply')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">TgBot::GenericReply</a></td></tr>
+<tr class="memitem:aa7bb5f2c5484cb791e1c60c346bbb06f inherit pub_types_class_tg_bot_1_1_generic_reply"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr&lt; <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">GenericReply</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">Ptr</a></td></tr>
+<tr class="separator:aa7bb5f2c5484cb791e1c60c346bbb06f inherit pub_types_class_tg_bot_1_1_generic_reply"><td class="memSeparator" colspan="2">&#160;</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:a42b8b08952603a9566757bbe7d543408"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a42b8b08952603a9566757bbe7d543408">removeKeyboard</a> = true</td></tr>
+<tr class="separator:a42b8b08952603a9566757bbe7d543408"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a840a781ad230cee4c50057a7c7f82828"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a840a781ad230cee4c50057a7c7f82828">selective</a> = false</td></tr>
+<tr class="separator:a840a781ad230cee4c50057a7c7f82828"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
+Additional Inherited Members</h2></td></tr>
+<tr class="inherit_header pub_methods_class_tg_bot_1_1_generic_reply"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_tg_bot_1_1_generic_reply')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">TgBot::GenericReply</a></td></tr>
+<tr class="memitem:a519019da5ab3cb27fc11bd56cc94123c inherit pub_methods_class_tg_bot_1_1_generic_reply"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html#a519019da5ab3cb27fc11bd56cc94123c">~GenericReply</a> ()</td></tr>
+<tr class="separator:a519019da5ab3cb27fc11bd56cc94123c inherit pub_methods_class_tg_bot_1_1_generic_reply"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see <a class="el" href="../../d2/d80/class_tg_bot_1_1_reply_keyboard_markup.html">ReplyKeyboardMarkup</a>). </p>
+
+<p class="definition">Definition at line <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html#l00020">20</a> of file <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.h</a>.</p>
+</div><h2 class="groupheader">Member Typedef Documentation</h2>
+<a id="aaa58ef7c177db3a3f46530bfb5fc0148"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaa58ef7c177db3a3f46530bfb5fc0148">&#9670;&nbsp;</a></span>Ptr</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef std::shared_ptr&lt;<a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html">ReplyKeyboardRemove</a>&gt; <a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#aaa58ef7c177db3a3f46530bfb5fc0148">TgBot::ReplyKeyboardRemove::Ptr</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html#l00023">23</a> of file <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.h</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Data Documentation</h2>
+<a id="a42b8b08952603a9566757bbe7d543408"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a42b8b08952603a9566757bbe7d543408">&#9670;&nbsp;</a></span>removeKeyboard</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const bool TgBot::ReplyKeyboardRemove::removeKeyboard = true</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in <a class="el" href="../../d2/d80/class_tg_bot_1_1_reply_keyboard_markup.html">ReplyKeyboardMarkup</a>) </p>
+
+<p class="definition">Definition at line <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html#l00029">29</a> of file <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.h</a>.</p>
+
+</div>
+</div>
+<a id="a840a781ad230cee4c50057a7c7f82828"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a840a781ad230cee4c50057a7c7f82828">&#9670;&nbsp;</a></span>selective</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool TgBot::ReplyKeyboardRemove::selective = false</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are  in the text of the <a class="el" href="../../d6/dce/class_tg_bot_1_1_message.html">Message</a> object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. </p>
+
+<p class="definition">Definition at line <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html#l00035">35</a> of file <a class="el" href="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.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="../../d8/d05/_reply_keyboard_remove_8h_source.html">ReplyKeyboardRemove.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="../../d8/d9d/namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="../../d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html">ReplyKeyboardRemove</a></li>
+    <li class="footer">Generated on Sun Jan 15 2017 02:33: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>
diff --git a/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js
new file mode 100644
index 0000000..1dbdfe8
--- /dev/null
+++ b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js
@@ -0,0 +1,6 @@
+var class_tg_bot_1_1_reply_keyboard_remove =
+[
+    [ "Ptr", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#aaa58ef7c177db3a3f46530bfb5fc0148", null ],
+    [ "removeKeyboard", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a42b8b08952603a9566757bbe7d543408", null ],
+    [ "selective", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a840a781ad230cee4c50057a7c7f82828", null ]
+];
+\ No newline at end of file
diff --git a/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png
new file mode 100644
index 0000000..cecb867
--- /dev/null
+++ b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png
author	Oleg Morozenkov <reo7sp@users.noreply.github.com>	2017-01-15 02:33:59 +0300
committer	Oleg Morozenkov <reo7sp@users.noreply.github.com>	2017-01-15 02:33:59 +0300
commit	b22c20c4db8c35eaee99075d055f74697c5805b8 (patch)
tree	b98fed35b212b5fdad9e03699658f769b3295424 /docs/d0/dff
parent	ae77f1220939915953419f232d4fc6441c88f96c (diff)