tastytea
/
mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity
This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/docs/card_8hpp_source.html

78 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodon-cpp: src/easy/entities/card.hpp Source File</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="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">mastodon-cpp
&#160;<span id="projectnumber">0.110.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9d328871126a6a5820f3cd5c0c41741e.html">easy</a></li><li class="navelem"><a class="el" href="dir_e526f556af6ddef7955f0f6556f0f4d0.html">entities</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">card.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This file is part of mastodon-cpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2018, 2019 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU Affero General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU Affero General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU Affero General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef MASTODON_CPP_EASY_CARD_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define MASTODON_CPP_EASY_CARD_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;../../mastodon-cpp.hpp&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;../entity.hpp&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">using</span> std::uint64_t;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span>Easy</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classMastodon_1_1Easy_1_1Card.html"> 38</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMastodon_1_1Easy_1_1Card.html">Card</a> : <span class="keyword">public</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html">Entity</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">using</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity::Entity</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a61f4a9a15eccf3d865fae52815871617">valid</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a001fe866019dd813223a7f54013d484d">author_name</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#aefc55ce8d87f4ab40cd97849c0fa6bf8">author_url</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#ae37473f2c2fe14658e733cb83dce80b5">description</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a8d3e5bcf3c92fb628dd11d7e38efa3b0">embed_url</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; uint64_t <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a5e49b309f58eb6175eb50a3980ae1e90">height</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#afd52f540ee3df4723a6c81f2f6fd89ed">html</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a2f39e65a3714bcebabfb1b5d37041fed">image</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a8939222efc873b5ef691a465246e2f87">provider_name</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#aaa5ed93fe315e8a3ece38d70d1e1ed7c">provider_url</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#ada692633e2756e95b1221253a8642dbd">title</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <a class="code" href="namespaceMastodon_1_1Easy.html#aa17ec4f385ac3bc773b1b2277f209341">Easy::card_type</a> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a857515e00d519f12306d54ffe0764b03">type</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a2dce11c8b0ea0ba1ee6c7ad8bc2d43a8">url</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; uint64_t <a class="code" href="classMastodon_1_1Easy_1_1Card.html#a2507e58e5e08f102c784a7d75b95bca6">width</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; };</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;}</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;}</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#endif // MASTODON_CPP_EASY_CARD_HPP</span></div><div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_aaa5ed93fe315e8a3ece38d70d1e1ed7c"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#aaa5ed93fe315e8a3ece38d70d1e1ed7c">Mastodon::Easy::Card::provider_url</a></div><div class="ttdeci">const string provider_url() const</div><div class="ttdoc">Returns the URL of the provider.</div><div class="ttdef"><b>Definition:</b> card.cpp:74</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a83eb2be5a13eaaa22b2796f05817f7a9"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Mastodon::Easy::Entity::Entity</a></div><div class="ttdeci">Entity()</div><div class="ttdoc">Constructs an empty Entity object.</div><div class="ttdef"><b>Definition:</b> entity.cpp:43</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html">Mastodon::Easy::Card</a></div><div class="ttdoc">Class to hold cards.</div><div class="ttdef"><b>Definition:</b> card.hpp:38</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a857515e00d519f12306d54ffe0764b03"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a857515e00d519f12306d54ffe0764b03">Mastodon::Easy::Card::type</a></div><div class="ttdeci">Easy::card_type type() const</div><div class="ttdoc">Returns the type of the card.</div><div class="ttdef"><b>Definition:</b> card.cpp:84</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_ada692633e2756e95b1221253a8642dbd"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#ada692633e2756e95b1221253a8642dbd">Mastodon::Easy::Card::title</a></div><div class="ttdeci">const string title() const</div><div class="ttdoc">Returns the title.</div><div class="ttdef"><b>Definition:</b> card.cpp:79</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_ae37473f2c2fe14658e733cb83dce80b5"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#ae37473f2c2fe14658e733cb83dce80b5">Mastodon::Easy::Card::description</a></div><div class="ttdeci">const string description() const</div><div class="ttdoc">Returns the description.</div><div class="ttdef"><b>Definition:</b> card.cpp:44</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a8d3e5bcf3c92fb628dd11d7e38efa3b0"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a8d3e5bcf3c92fb628dd11d7e38efa3b0">Mastodon::Easy::Card::embed_url</a></div><div class="ttdeci">const string embed_url() const</div><div class="ttdoc">Returns the embed URL.</div><div class="ttdef"><b>Definition:</b> card.cpp:49</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_aefc55ce8d87f4ab40cd97849c0fa6bf8"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#aefc55ce8d87f4ab40cd97849c0fa6bf8">Mastodon::Easy::Card::author_url</a></div><div class="ttdeci">const string author_url() const</div><div class="ttdoc">Returns the URL of the author.</div><div class="ttdef"><b>Definition:</b> card.cpp:39</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a5e49b309f58eb6175eb50a3980ae1e90"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a5e49b309f58eb6175eb50a3980ae1e90">Mastodon::Easy::Card::height</a></div><div class="ttdeci">uint64_t height() const</div><div class="ttdoc">Returns the height of the card.</div><div class="ttdef"><b>Definition:</b> card.cpp:54</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a2dce11c8b0ea0ba1ee6c7ad8bc2d43a8"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a2dce11c8b0ea0ba1ee6c7ad8bc2d43a8">Mastodon::Easy::Card::url</a></div><div class="ttdeci">const string url() const</div><div class="ttdoc">Returns the URL associated with the card.</div><div class="ttdef"><b>Definition:</b> card.cpp:99</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a001fe866019dd813223a7f54013d484d"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a001fe866019dd813223a7f54013d484d">Mastodon::Easy::Card::author_name</a></div><div class="ttdeci">const string author_name() const</div><div class="ttdoc">Returns the name of the author.</div><div class="ttdef"><b>Definition:</b> card.cpp:34</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a8939222efc873b5ef691a465246e2f87"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a8939222efc873b5ef691a465246e2f87">Mastodon::Easy::Card::provider_name</a></div><div class="ttdeci">const string provider_name() const</div><div class="ttdoc">Returns the name of the provider.</div><div class="ttdef"><b>Definition:</b> card.cpp:69</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a61f4a9a15eccf3d865fae52815871617"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a61f4a9a15eccf3d865fae52815871617">Mastodon::Easy::Card::valid</a></div><div class="ttdeci">virtual bool valid() const override</div><div class="ttdoc">Returns true if the Entity holds valid data.</div><div class="ttdef"><b>Definition:</b> card.cpp:23</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a2507e58e5e08f102c784a7d75b95bca6"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a2507e58e5e08f102c784a7d75b95bca6">Mastodon::Easy::Card::width</a></div><div class="ttdeci">uint64_t width() const</div><div class="ttdoc">Returns the width of the card.</div><div class="ttdef"><b>Definition:</b> card.cpp:104</div></div>
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdoc">Collection of things to interface with server software that implements the Mastodon API.</div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:47</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></div><div class="ttdoc">Base class for all entities.</div><div class="ttdef"><b>Definition:</b> entity.hpp:36</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_a2f39e65a3714bcebabfb1b5d37041fed"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#a2f39e65a3714bcebabfb1b5d37041fed">Mastodon::Easy::Card::image</a></div><div class="ttdeci">const string image() const</div><div class="ttdoc">Returns the URL of the image associated with the card.</div><div class="ttdef"><b>Definition:</b> card.cpp:64</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Card_html_afd52f540ee3df4723a6c81f2f6fd89ed"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Card.html#afd52f540ee3df4723a6c81f2f6fd89ed">Mastodon::Easy::Card::html</a></div><div class="ttdeci">const string html() const</div><div class="ttdoc">Returns the HTML.</div><div class="ttdef"><b>Definition:</b> card.cpp:59</div></div>
<div class="ttc" id="namespaceMastodon_1_1Easy_html_aa17ec4f385ac3bc773b1b2277f209341"><div class="ttname"><a href="namespaceMastodon_1_1Easy.html#aa17ec4f385ac3bc773b1b2277f209341">Mastodon::Easy::card_type</a></div><div class="ttdeci">card_type</div><div class="ttdoc">Describes the card type.</div><div class="ttdef"><b>Definition:</b> types_easy.hpp:83</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink