diff options
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/d8/ded | |
parent | ae77f1220939915953419f232d4fc6441c88f96c (diff) |
Docs
Diffstat (limited to 'docs/d8/ded')
-rw-r--r-- | docs/d8/ded/class_tg_bot_1_1_http_req_arg.html | 276 | ||||
-rw-r--r-- | docs/d8/ded/class_tg_bot_1_1_http_req_arg.js | 9 |
2 files changed, 285 insertions, 0 deletions
diff --git a/docs/d8/ded/class_tg_bot_1_1_http_req_arg.html b/docs/d8/ded/class_tg_bot_1_1_http_req_arg.html new file mode 100644 index 0000000..ad7dbd0 --- /dev/null +++ b/docs/d8/ded/class_tg_bot_1_1_http_req_arg.html @@ -0,0 +1,276 @@ +<!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::HttpReqArg 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('d8/ded/class_tg_bot_1_1_http_req_arg.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-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="../../d8/d14/class_tg_bot_1_1_http_req_arg-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::HttpReqArg Class Reference<div class="ingroups"><a class="el" href="../../d9/dd2/group__net.html">Net</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.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:aaff7072fe781f191ddca430088447d19"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:aaff7072fe781f191ddca430088447d19"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#aaff7072fe781f191ddca430088447d19">HttpReqArg</a> (const std::string &<a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a9772f0982d33fdebe587106d0b4f921d">name</a>, const T &<a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#ae854084229a093b6819953d0055844eb">value</a>, bool <a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a9e372ea4360d239037cfeb673d31d9f3">isFile</a>=false, const std::string &<a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a74387e5b5fe9713a805b33e693930bd5">mimeType</a>="text/plain", const std::string &<a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#af75b0592fd96d9dcc31f7f5dc95425dc">fileName</a>="")</td></tr> +<tr class="separator:aaff7072fe781f191ddca430088447d19"><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:a9772f0982d33fdebe587106d0b4f921d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a9772f0982d33fdebe587106d0b4f921d">name</a></td></tr> +<tr class="separator:a9772f0982d33fdebe587106d0b4f921d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae854084229a093b6819953d0055844eb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#ae854084229a093b6819953d0055844eb">value</a></td></tr> +<tr class="separator:ae854084229a093b6819953d0055844eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9e372ea4360d239037cfeb673d31d9f3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a9e372ea4360d239037cfeb673d31d9f3">isFile</a> = false</td></tr> +<tr class="separator:a9e372ea4360d239037cfeb673d31d9f3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74387e5b5fe9713a805b33e693930bd5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#a74387e5b5fe9713a805b33e693930bd5">mimeType</a> = "text/plain"</td></tr> +<tr class="separator:a74387e5b5fe9713a805b33e693930bd5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af75b0592fd96d9dcc31f7f5dc95425dc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/ded/class_tg_bot_1_1_http_req_arg.html#af75b0592fd96d9dcc31f7f5dc95425dc">fileName</a></td></tr> +<tr class="separator:af75b0592fd96d9dcc31f7f5dc95425dc"><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 class represents argument in POST http requests. </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00038">38</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="aaff7072fe781f191ddca430088447d19"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaff7072fe781f191ddca430088447d19">◆ </a></span>HttpReqArg()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">TgBot::HttpReqArg::HttpReqArg </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>isFile</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>mimeType</em> = <code>"text/plain"</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>fileName</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</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 class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00042">42</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="af75b0592fd96d9dcc31f7f5dc95425dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af75b0592fd96d9dcc31f7f5dc95425dc">◆ </a></span>fileName</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::HttpReqArg::fileName</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Should be set if an argument value hold some file contents </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00070">70</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<a id="a9e372ea4360d239037cfeb673d31d9f3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9e372ea4360d239037cfeb673d31d9f3">◆ </a></span>isFile</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::HttpReqArg::isFile = false</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Should be true if an argument value hold some file contents </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00060">60</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<a id="a74387e5b5fe9713a805b33e693930bd5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a74387e5b5fe9713a805b33e693930bd5">◆ </a></span>mimeType</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::HttpReqArg::mimeType = "text/plain"</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Mime type of an argument value. This field makes sense only if isFile is true. </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00065">65</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<a id="a9772f0982d33fdebe587106d0b4f921d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9772f0982d33fdebe587106d0b4f921d">◆ </a></span>name</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::HttpReqArg::name</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Name of an argument. </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00050">50</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<a id="ae854084229a093b6819953d0055844eb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae854084229a093b6819953d0055844eb">◆ </a></span>value</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::HttpReqArg::value</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Value of an argument. </p> + +<p class="definition">Definition at line <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html#l00055">55</a> of file <a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/net/<a class="el" href="../../dc/d67/_http_req_arg_8h_source.html">HttpReqArg.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="../../d8/ded/class_tg_bot_1_1_http_req_arg.html">HttpReqArg</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:33:16 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/d8/ded/class_tg_bot_1_1_http_req_arg.js b/docs/d8/ded/class_tg_bot_1_1_http_req_arg.js new file mode 100644 index 0000000..adfbd65 --- /dev/null +++ b/docs/d8/ded/class_tg_bot_1_1_http_req_arg.js @@ -0,0 +1,9 @@ +var class_tg_bot_1_1_http_req_arg = +[ + [ "HttpReqArg", "d8/ded/class_tg_bot_1_1_http_req_arg.html#aaff7072fe781f191ddca430088447d19", null ], + [ "fileName", "d8/ded/class_tg_bot_1_1_http_req_arg.html#af75b0592fd96d9dcc31f7f5dc95425dc", null ], + [ "isFile", "d8/ded/class_tg_bot_1_1_http_req_arg.html#a9e372ea4360d239037cfeb673d31d9f3", null ], + [ "mimeType", "d8/ded/class_tg_bot_1_1_http_req_arg.html#a74387e5b5fe9713a805b33e693930bd5", null ], + [ "name", "d8/ded/class_tg_bot_1_1_http_req_arg.html#a9772f0982d33fdebe587106d0b4f921d", null ], + [ "value", "d8/ded/class_tg_bot_1_1_http_req_arg.html#ae854084229a093b6819953d0055844eb", null ] +];
\ No newline at end of file |