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

426
en/doxygen/html/classUnitDisplayStatusBarControl.html Normal file
View file

@ -0,0 +1,426 @@
<!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: UnitDisplayStatusBarControl 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('classUnitDisplayStatusBarControl.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-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-slots">Private Slots</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classUnitDisplayStatusBarControl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UnitDisplayStatusBarControl Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="bitcoingui_8h_source.html">bitcoingui.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 UnitDisplayStatusBarControl:</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="classUnitDisplayStatusBarControl.png" usemap="#UnitDisplayStatusBarControl_map" alt=""/>
<map id="UnitDisplayStatusBarControl_map" name="UnitDisplayStatusBarControl_map">
</map>
</div></div>
<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:a7db4ef1ea7a6a457d7981ee1719b62c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a7db4ef1ea7a6a457d7981ee1719b62c1">UnitDisplayStatusBarControl</a> (const <a class="el" href="classPlatformStyle.html">PlatformStyle</a> *platformStyle)</td></tr>
<tr class="separator:a7db4ef1ea7a6a457d7981ee1719b62c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8d2a43f66f3f71c7d6926dbd5927066"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#ac8d2a43f66f3f71c7d6926dbd5927066">setOptionsModel</a> (<a class="el" href="classOptionsModel.html">OptionsModel</a> *<a class="el" href="classUnitDisplayStatusBarControl.html#a62e10f0662b19879d0897da57ed69ce8">optionsModel</a>)</td></tr>
<tr class="separator:ac8d2a43f66f3f71c7d6926dbd5927066"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a645cb0f2a435881ca9cc5ac09355cff0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a645cb0f2a435881ca9cc5ac09355cff0">mousePressEvent</a> (QMouseEvent *event)</td></tr>
<tr class="separator:a645cb0f2a435881ca9cc5ac09355cff0"><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:a380947f855d0a7ca8c457ad463c359bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a380947f855d0a7ca8c457ad463c359bb">updateDisplayUnit</a> (int newUnits)</td></tr>
<tr class="separator:a380947f855d0a7ca8c457ad463c359bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8989bed2d30e0e376046356adc216a12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a8989bed2d30e0e376046356adc216a12">onMenuSelection</a> (QAction *action)</td></tr>
<tr class="separator:a8989bed2d30e0e376046356adc216a12"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ae9eeb30020311515b4b8d85a460fb596"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#ae9eeb30020311515b4b8d85a460fb596">onDisplayUnitsClicked</a> (const QPoint &amp;point)</td></tr>
<tr class="separator:ae9eeb30020311515b4b8d85a460fb596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d131e977c2e9095d05d362d456a0e47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a3d131e977c2e9095d05d362d456a0e47">createContextMenu</a> ()</td></tr>
<tr class="separator:a3d131e977c2e9095d05d362d456a0e47"><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:a62e10f0662b19879d0897da57ed69ce8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOptionsModel.html">OptionsModel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a62e10f0662b19879d0897da57ed69ce8">optionsModel</a></td></tr>
<tr class="separator:a62e10f0662b19879d0897da57ed69ce8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0652e8e34f177bf9e3cee0f234ab861c"><td class="memItemLeft" align="right" valign="top">QMenu *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnitDisplayStatusBarControl.html#a0652e8e34f177bf9e3cee0f234ab861c">menu</a></td></tr>
<tr class="separator:a0652e8e34f177bf9e3cee0f234ab861c"><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 class="definition">Definition at line <a class="el" href="bitcoingui_8h_source.html#l00285">285</a> of file <a class="el" href="bitcoingui_8h_source.html">bitcoingui.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7db4ef1ea7a6a457d7981ee1719b62c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7db4ef1ea7a6a457d7981ee1719b62c1">&#9670;&nbsp;</a></span>UnitDisplayStatusBarControl()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">UnitDisplayStatusBarControl::UnitDisplayStatusBarControl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPlatformStyle.html">PlatformStyle</a> *&#160;</td>
<td class="paramname"><em>platformStyle</em></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 class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01462">1462</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3d131e977c2e9095d05d362d456a0e47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d131e977c2e9095d05d362d456a0e47">&#9670;&nbsp;</a></span>createContextMenu()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::createContextMenu </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates context menu, its actions, and wires up all the relevant signals for mouse events. </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01487">1487</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01462">UnitDisplayStatusBarControl()</a>.</p>
</div>
</div>
<a id="a645cb0f2a435881ca9cc5ac09355cff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a645cb0f2a435881ca9cc5ac09355cff0">&#9670;&nbsp;</a></span>mousePressEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::mousePressEvent </td>
<td>(</td>
<td class="paramtype">QMouseEvent *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>So that it responds to left-button clicks</p>
<p>So that it responds to button clicks </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01481">1481</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
</div>
</div>
<a id="ae9eeb30020311515b4b8d85a460fb596"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9eeb30020311515b4b8d85a460fb596">&#9670;&nbsp;</a></span>onDisplayUnitsClicked()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::onDisplayUnitsClicked </td>
<td>(</td>
<td class="paramtype">const QPoint &amp;&#160;</td>
<td class="paramname"><em>point</em></td><td>)</td>
<td></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>Shows context menu with Display Unit options by the mouse coordinates </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01521">1521</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01481">mousePressEvent()</a>.</p>
</div>
</div>
<a id="a8989bed2d30e0e376046356adc216a12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8989bed2d30e0e376046356adc216a12">&#9670;&nbsp;</a></span>onMenuSelection</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::onMenuSelection </td>
<td>(</td>
<td class="paramtype">QAction *&#160;</td>
<td class="paramname"><em>action</em></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>Tells underlying optionsModel to update its current display unit. </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01528">1528</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01487">createContextMenu()</a>.</p>
</div>
</div>
<a id="ac8d2a43f66f3f71c7d6926dbd5927066"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8d2a43f66f3f71c7d6926dbd5927066">&#9670;&nbsp;</a></span>setOptionsModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::setOptionsModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOptionsModel.html">OptionsModel</a> *&#160;</td>
<td class="paramname"><em>optionsModel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lets the control know about the Options Model (and its signals) </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01500">1500</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l00584">BitcoinGUI::setClientModel()</a>.</p>
</div>
</div>
<a id="a380947f855d0a7ca8c457ad463c359bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a380947f855d0a7ca8c457ad463c359bb">&#9670;&nbsp;</a></span>updateDisplayUnit</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UnitDisplayStatusBarControl::updateDisplayUnit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>newUnits</em></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>When Display Units are changed on <a class="el" href="classOptionsModel.html">OptionsModel</a> it will refresh the display text of the control on the status bar </p>
<p class="definition">Definition at line <a class="el" href="bitcoingui_8cpp_source.html#l01515">1515</a> of file <a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01500">setOptionsModel()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0652e8e34f177bf9e3cee0f234ab861c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0652e8e34f177bf9e3cee0f234ab861c">&#9670;&nbsp;</a></span>menu</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QMenu* UnitDisplayStatusBarControl::menu</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="bitcoingui_8h_source.html#l00300">300</a> of file <a class="el" href="bitcoingui_8h_source.html">bitcoingui.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01487">createContextMenu()</a>, and <a class="el" href="bitcoingui_8cpp_source.html#l01521">onDisplayUnitsClicked()</a>.</p>
</div>
</div>
<a id="a62e10f0662b19879d0897da57ed69ce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62e10f0662b19879d0897da57ed69ce8">&#9670;&nbsp;</a></span>optionsModel</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="classOptionsModel.html">OptionsModel</a>* UnitDisplayStatusBarControl::optionsModel</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="bitcoingui_8h_source.html#l00299">299</a> of file <a class="el" href="bitcoingui_8h_source.html">bitcoingui.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitcoingui_8cpp_source.html#l01528">onMenuSelection()</a>, and <a class="el" href="bitcoingui_8cpp_source.html#l01500">setOptionsModel()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/qt/<a class="el" href="bitcoingui_8h_source.html">bitcoingui.h</a></li>
<li>src/qt/<a class="el" href="bitcoingui_8cpp_source.html">bitcoingui.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="classUnitDisplayStatusBarControl.html">UnitDisplayStatusBarControl</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>