300 lines
15 KiB
HTML
300 lines
15 KiB
HTML
<!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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GpgFrontend Project: GpgFrontend::UI::HelpPage 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>
|
|
<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">GpgFrontend Project
|
|
</div>
|
|
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classGpgFrontend_1_1UI_1_1HelpPage.html',''); initResizable(); });
|
|
/* @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-slots">Public Slots</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classGpgFrontend_1_1UI_1_1HelpPage-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GpgFrontend::UI::HelpPage Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for GpgFrontend::UI::HelpPage:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classGpgFrontend_1_1UI_1_1HelpPage__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1UI_1_1HelpPage_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aGpgFrontend_1_1UI_1_1HelpPage_inherit__map" id="aGpgFrontend_1_1UI_1_1HelpPage_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="5,131,201,252"/>
|
|
<area shape="rect" title=" " alt="" coords="64,5,143,83"/>
|
|
</map>
|
|
</div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for GpgFrontend::UI::HelpPage:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classGpgFrontend_1_1UI_1_1HelpPage__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1UI_1_1HelpPage_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aGpgFrontend_1_1UI_1_1HelpPage_coll__map" id="aGpgFrontend_1_1UI_1_1HelpPage_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="5,131,201,252"/>
|
|
<area shape="rect" title=" " alt="" coords="64,5,143,83"/>
|
|
</map>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
|
|
Public Slots</h2></td></tr>
|
|
<tr class="memitem:a51ff99077a75507365307f5dd783df99"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a51ff99077a75507365307f5dd783df99">slot_open_url</a> (const QUrl &url)</td></tr>
|
|
<tr class="separator:a51ff99077a75507365307f5dd783df99"><td class="memSeparator" colspan="2"> </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:a1be8f5b79fef3d1d62ff4620b8535006"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a1be8f5b79fef3d1d62ff4620b8535006">HelpPage</a> (const QString &path, QWidget *parent=nullptr)</td></tr>
|
|
<tr class="memdesc:a1be8f5b79fef3d1d62ff4620b8535006"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new Help Page object. <a href="classGpgFrontend_1_1UI_1_1HelpPage.html#a1be8f5b79fef3d1d62ff4620b8535006">More...</a><br /></td></tr>
|
|
<tr class="separator:a1be8f5b79fef3d1d62ff4620b8535006"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92c31eea47b42be28c86431384b27846"><td class="memItemLeft" align="right" valign="top">QTextBrowser * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a92c31eea47b42be28c86431384b27846">GetBrowser</a> ()</td></tr>
|
|
<tr class="memdesc:a92c31eea47b42be28c86431384b27846"><td class="mdescLeft"> </td><td class="mdescRight">Get the Browser object. <a href="classGpgFrontend_1_1UI_1_1HelpPage.html#a92c31eea47b42be28c86431384b27846">More...</a><br /></td></tr>
|
|
<tr class="separator:a92c31eea47b42be28c86431384b27846"><td class="memSeparator" colspan="2"> </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:af839ba3ff0decc82aadb922593acf53f"><td class="memItemLeft" align="right" valign="top">QUrl </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f">localized_help</a> (const QUrl &path)</td></tr>
|
|
<tr class="memdesc:af839ba3ff0decc82aadb922593acf53f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f" title="HelpPage::localized_help check if the requested file is also available with the locale,...">HelpPage::localized_help</a> check if the requested file is also available with the locale, e.g. return index.de.html if index.html was requested but the locale is de and index.de.html is available. <a href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f">More...</a><br /></td></tr>
|
|
<tr class="separator:af839ba3ff0decc82aadb922593acf53f"><td class="memSeparator" colspan="2"> </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:af4f61342fae06a49c95d8d20ca51ca2c"><td class="memItemLeft" align="right" valign="top"><a id="af4f61342fae06a49c95d8d20ca51ca2c"></a>
|
|
QTextBrowser * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af4f61342fae06a49c95d8d20ca51ca2c">browser_</a></td></tr>
|
|
<tr class="memdesc:af4f61342fae06a49c95d8d20ca51ca2c"><td class="mdescLeft"> </td><td class="mdescRight">The textbrowser of the tab. <br /></td></tr>
|
|
<tr class="separator:af4f61342fae06a49c95d8d20ca51ca2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a1be8f5b79fef3d1d62ff4620b8535006"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1be8f5b79fef3d1d62ff4620b8535006">◆ </a></span>HelpPage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpgFrontend::UI::HelpPage::HelpPage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget * </td>
|
|
<td class="paramname"><em>parent</em> = <code>nullptr</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">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new Help Page object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td></td></tr>
|
|
<tr><td class="paramname">parent</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af4f61342fae06a49c95d8d20ca51ca2c">browser_</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f">localized_help()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a51ff99077a75507365307f5dd783df99">slot_open_url()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a92c31eea47b42be28c86431384b27846"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92c31eea47b42be28c86431384b27846">◆ </a></span>GetBrowser()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QTextBrowser * GpgFrontend::UI::HelpPage::GetBrowser </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the Browser object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>QTextBrowser* </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af4f61342fae06a49c95d8d20ca51ca2c">browser_</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af839ba3ff0decc82aadb922593acf53f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af839ba3ff0decc82aadb922593acf53f">◆ </a></span>localized_help()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto GpgFrontend::UI::HelpPage::localized_help </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QUrl & </td>
|
|
<td class="paramname"><em>url</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><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f" title="HelpPage::localized_help check if the requested file is also available with the locale,...">HelpPage::localized_help</a> check if the requested file is also available with the locale, e.g. return index.de.html if index.html was requested but the locale is de and index.de.html is available. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">url</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a1be8f5b79fef3d1d62ff4620b8535006">HelpPage()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a51ff99077a75507365307f5dd783df99">slot_open_url()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51ff99077a75507365307f5dd783df99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51ff99077a75507365307f5dd783df99">◆ </a></span>slot_open_url</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GpgFrontend::UI::HelpPage::slot_open_url </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QUrl & </td>
|
|
<td class="paramname"><em>url</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">url</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af4f61342fae06a49c95d8d20ca51ca2c">browser_</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#af839ba3ff0decc82aadb922593acf53f">localized_help()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html#a1be8f5b79fef3d1d62ff4620b8535006">HelpPage()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/ui/widgets/<a class="el" href="HelpPage_8h_source.html">HelpPage.h</a></li>
|
|
<li>src/ui/widgets/HelpPage.cpp</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="namespaceGpgFrontend.html">GpgFrontend</a></li><li class="navelem"><a class="el" href="namespaceGpgFrontend_1_1UI.html">UI</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1UI_1_1HelpPage.html">HelpPage</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|