diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_message_entity.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_message_entity.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_message_entity.html b/docs/class_tg_bot_1_1_message_entity.html new file mode 100644 index 0000000..78b7e80 --- /dev/null +++ b/docs/class_tg_bot_1_1_message_entity.html @@ -0,0 +1,233 @@ +<!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::MessageEntity 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_message_entity.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_message_entity-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::MessageEntity 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="_message_entity_8h_source.html">MessageEntity.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:a6710ffdbafba909633df7bcd8c488da0"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_message_entity.html">MessageEntity</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#a6710ffdbafba909633df7bcd8c488da0">Ptr</a></td></tr> +<tr class="separator:a6710ffdbafba909633df7bcd8c488da0"><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:adec4d61f5859cb0384e84dbe18988d78"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#adec4d61f5859cb0384e84dbe18988d78">type</a></td></tr> +<tr class="separator:adec4d61f5859cb0384e84dbe18988d78"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad8da7260ae4360536a0a461e6c5b628"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#aad8da7260ae4360536a0a461e6c5b628">offset</a></td></tr> +<tr class="separator:aad8da7260ae4360536a0a461e6c5b628"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3f41be5fd732173bd84093df20a58e38"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#a3f41be5fd732173bd84093df20a58e38">length</a></td></tr> +<tr class="separator:a3f41be5fd732173bd84093df20a58e38"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2cf6b38ee3116a4589d5f8263e53c51f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#a2cf6b38ee3116a4589d5f8263e53c51f">url</a></td></tr> +<tr class="separator:a2cf6b38ee3116a4589d5f8263e53c51f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:affef16e94f7f3382260b85c66726bc48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">User::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_message_entity.html#affef16e94f7f3382260b85c66726bc48">user</a></td></tr> +<tr class="separator:affef16e94f7f3382260b85c66726bc48"><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 special entity in a text message. For example, hashtags, usernames, URLs, etc. </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00018">18</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a6710ffdbafba909633df7bcd8c488da0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6710ffdbafba909633df7bcd8c488da0">◆ </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_message_entity.html">MessageEntity</a>> <a class="el" href="class_tg_bot_1_1_message_entity.html#a6710ffdbafba909633df7bcd8c488da0">TgBot::MessageEntity::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00020">20</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a3f41be5fd732173bd84093df20a58e38"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3f41be5fd732173bd84093df20a58e38">◆ </a></span>length</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::MessageEntity::length</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Length of the entity in UTF-16 code units </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00035">35</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> + +</div> +</div> +<a id="aad8da7260ae4360536a0a461e6c5b628"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aad8da7260ae4360536a0a461e6c5b628">◆ </a></span>offset</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::MessageEntity::offset</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Offset in UTF-16 code units to the start of the entity. </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00030">30</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> + +</div> +</div> +<a id="adec4d61f5859cb0384e84dbe18988d78"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adec4d61f5859cb0384e84dbe18988d78">◆ </a></span>type</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::MessageEntity::type</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Type of the entity. One of mention (), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs). </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00025">25</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> + +</div> +</div> +<a id="a2cf6b38ee3116a4589d5f8263e53c51f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2cf6b38ee3116a4589d5f8263e53c51f">◆ </a></span>url</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::MessageEntity::url</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. For “text_link” only, url that will be opened after user taps on the text </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00040">40</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.h</a>.</p> + +</div> +</div> +<a id="affef16e94f7f3382260b85c66726bc48"></a> +<h2 class="memtitle"><span class="permalink"><a href="#affef16e94f7f3382260b85c66726bc48">◆ </a></span>user</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">User::Ptr</a> TgBot::MessageEntity::user</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. For “text_mention” only, the mentioned user </p> + +<p class="definition">Definition at line <a class="el" href="_message_entity_8h_source.html#l00045">45</a> of file <a class="el" href="_message_entity_8h_source.html">MessageEntity.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="_message_entity_8h_source.html">MessageEntity.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_message_entity.html">MessageEntity</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> |