joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add doxygen docs and link to them from main page

Browse source
This commit is contained in:
thephez 2017-12-14 15:34:41 -05:00
parent d327ad9771
commit f94fdd7239
5496 changed files with 984413 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

368
en/doxygen/html/classHelpMessageDialog.html Normal file
View file

@ -0,0 +1,368 @@
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: HelpMessageDialog 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classHelpMessageDialog.html','');});
/* @license-end */
</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-methods">Public Member Functions</a> &#124;
<a href="#pri-slots">Private Slots</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classHelpMessageDialog-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HelpMessageDialog Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for HelpMessageDialog:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classHelpMessageDialog.png" usemap="#HelpMessageDialog_map" alt=""/>
<map id="HelpMessageDialog_map" name="HelpMessageDialog_map">
</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:a72eba10b6a4f30a6e5e412eb52cfa053"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053">HelpMode</a> { <a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053abe45ab73d1e188b5b9c37ed0609bf284">about</a>,
<a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053a7bc7c71aec6da2c6f4fea1a3a5199feb">cmdline</a>,
<a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053a6dbf08ab8ca2beac4e7950db9ed896d4">pshelp</a>
}</td></tr>
<tr class="separator:a72eba10b6a4f30a6e5e412eb52cfa053"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af8e110c563ee9772b34c22a57613ad80"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#af8e110c563ee9772b34c22a57613ad80">HelpMessageDialog</a> (QWidget *parent, <a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053">HelpMode</a> helpMode)</td></tr>
<tr class="separator:af8e110c563ee9772b34c22a57613ad80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5393c6af4412e0fcab05b0824cb0ef18"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#a5393c6af4412e0fcab05b0824cb0ef18">~HelpMessageDialog</a> ()</td></tr>
<tr class="separator:a5393c6af4412e0fcab05b0824cb0ef18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca63e190e624f6fc6208196345d9c23f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#aca63e190e624f6fc6208196345d9c23f">printToConsole</a> ()</td></tr>
<tr class="separator:aca63e190e624f6fc6208196345d9c23f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0078c816ad197f6d27352c9591f3c34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#ac0078c816ad197f6d27352c9591f3c34">showOrPrint</a> ()</td></tr>
<tr class="separator:ac0078c816ad197f6d27352c9591f3c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-slots"></a>
Private Slots</h2></td></tr>
<tr class="memitem:a04cbd9651dbd51f03c007a55e36e089f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#a04cbd9651dbd51f03c007a55e36e089f">on_okButton_accepted</a> ()</td></tr>
<tr class="separator:a04cbd9651dbd51f03c007a55e36e089f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af8d50f71415b8d1ad360d249dde19bb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUi_1_1HelpMessageDialog.html">Ui::HelpMessageDialog</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#af8d50f71415b8d1ad360d249dde19bb4">ui</a></td></tr>
<tr class="separator:af8d50f71415b8d1ad360d249dde19bb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb8617d6697a51cb275919d768ea511e"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHelpMessageDialog.html#adb8617d6697a51cb275919d768ea511e">text</a></td></tr>
<tr class="separator:adb8617d6697a51cb275919d768ea511e"><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>"Help message" dialog box </p>
<p class="definition">Definition at line <a class="el" href="utilitydialog_8h_source.html#l00019">19</a> of file <a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a72eba10b6a4f30a6e5e412eb52cfa053"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72eba10b6a4f30a6e5e412eb52cfa053">&#9670;&nbsp;</a></span>HelpMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053">HelpMessageDialog::HelpMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a72eba10b6a4f30a6e5e412eb52cfa053abe45ab73d1e188b5b9c37ed0609bf284"></a>about&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a72eba10b6a4f30a6e5e412eb52cfa053a7bc7c71aec6da2c6f4fea1a3a5199feb"></a>cmdline&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a72eba10b6a4f30a6e5e412eb52cfa053a6dbf08ab8ca2beac4e7950db9ed896d4"></a>pshelp&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="utilitydialog_8h_source.html#l00024">24</a> of file <a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af8e110c563ee9772b34c22a57613ad80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8e110c563ee9772b34c22a57613ad80">&#9670;&nbsp;</a></span>HelpMessageDialog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">HelpMessageDialog::HelpMessageDialog </td>
<td>(</td>
<td class="paramtype">QWidget *&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classHelpMessageDialog.html#a72eba10b6a4f30a6e5e412eb52cfa053">HelpMode</a>&#160;</td>
<td class="paramname"><em>helpMode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>"Help message" or "About" dialog box </p>
<p>HTML-format the license message from the core </p>
<p class="definition">Definition at line <a class="el" href="utilitydialog_8cpp_source.html#l00031">31</a> of file <a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</a>.</p>
</div>
</div>
<a id="a5393c6af4412e0fcab05b0824cb0ef18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5393c6af4412e0fcab05b0824cb0ef18">&#9670;&nbsp;</a></span>~HelpMessageDialog()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HelpMessageDialog::~HelpMessageDialog </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8cpp_source.html#l00172">172</a> of file <a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a04cbd9651dbd51f03c007a55e36e089f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04cbd9651dbd51f03c007a55e36e089f">&#9670;&nbsp;</a></span>on_okButton_accepted</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void HelpMessageDialog::on_okButton_accepted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8cpp_source.html#l00194">194</a> of file <a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</a>.</p>
</div>
</div>
<a id="aca63e190e624f6fc6208196345d9c23f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca63e190e624f6fc6208196345d9c23f">&#9670;&nbsp;</a></span>printToConsole()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpMessageDialog::printToConsole </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8cpp_source.html#l00177">177</a> of file <a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="utilitydialog_8cpp_source.html#l00183">showOrPrint()</a>.</p>
</div>
</div>
<a id="ac0078c816ad197f6d27352c9591f3c34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0078c816ad197f6d27352c9591f3c34">&#9670;&nbsp;</a></span>showOrPrint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpMessageDialog::showOrPrint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8cpp_source.html#l00183">183</a> of file <a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adb8617d6697a51cb275919d768ea511e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb8617d6697a51cb275919d768ea511e">&#9670;&nbsp;</a></span>text</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString HelpMessageDialog::text</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8h_source.html#l00038">38</a> of file <a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="utilitydialog_8cpp_source.html#l00031">HelpMessageDialog()</a>, and <a class="el" href="utilitydialog_8cpp_source.html#l00177">printToConsole()</a>.</p>
</div>
</div>
<a id="af8d50f71415b8d1ad360d249dde19bb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8d50f71415b8d1ad360d249dde19bb4">&#9670;&nbsp;</a></span>ui</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUi_1_1HelpMessageDialog.html">Ui::HelpMessageDialog</a>* HelpMessageDialog::ui</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="utilitydialog_8h_source.html#l00037">37</a> of file <a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="utilitydialog_8cpp_source.html#l00031">HelpMessageDialog()</a>, and <a class="el" href="utilitydialog_8cpp_source.html#l00172">~HelpMessageDialog()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/qt/<a class="el" href="utilitydialog_8h_source.html">utilitydialog.h</a></li>
<li>src/qt/<a class="el" href="utilitydialog_8cpp_source.html">utilitydialog.cpp</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="classHelpMessageDialog.html">HelpMessageDialog</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:13 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>