GpgFrontend/GpgFrontend-Doxygen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d40bfb57a9
GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1UI_1_1SettingsObject.html

312 lines
18 KiB
HTML
Raw 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::UI::SettingsObject 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&amp;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&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('classGpgFrontend_1_1UI_1_1SettingsObject.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-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1UI_1_1SettingsObject-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::UI::SettingsObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html" title="The SettingsObject class This class is used to store settings for the application securely.">SettingsObject</a> class This class is used to store settings for the application securely.
<a href="classGpgFrontend_1_1UI_1_1SettingsObject.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SettingsObject_8h_source.html">SettingsObject.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for GpgFrontend::UI::SettingsObject:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1UI_1_1SettingsObject__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1UI_1_1SettingsObject_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1UI_1_1SettingsObject_inherit__map" id="aGpgFrontend_1_1UI_1_1SettingsObject_inherit__map">
<area shape="rect" title="The SettingsObject class This class is used to store settings for the application securely." alt="" coords="5,131,193,281"/>
<area shape="rect" title=" " alt="" coords="38,5,161,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::UI::SettingsObject:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1UI_1_1SettingsObject__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1UI_1_1SettingsObject_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1UI_1_1SettingsObject_coll__map" id="aGpgFrontend_1_1UI_1_1SettingsObject_coll__map">
<area shape="rect" title="The SettingsObject class This class is used to store settings for the application securely." alt="" coords="5,287,193,437"/>
<area shape="rect" title=" " alt="" coords="17,147,139,224"/>
<area shape="rect" title=" " alt="" coords="164,147,251,224"/>
<area shape="rect" title=" " alt="" coords="138,5,277,97"/>
</map>
</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:aad706a2c2b68d280b5d3ababff0ff302"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html#aad706a2c2b68d280b5d3ababff0ff302">SettingsObject</a> (std::string settings_name)</td></tr>
<tr class="memdesc:aad706a2c2b68d280b5d3ababff0ff302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Settings Object object. <a href="classGpgFrontend_1_1UI_1_1SettingsObject.html#aad706a2c2b68d280b5d3ababff0ff302">More...</a><br /></td></tr>
<tr class="separator:aad706a2c2b68d280b5d3ababff0ff302"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac11d19096b4e88cb288a208a4953af4d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html#ac11d19096b4e88cb288a208a4953af4d">SettingsObject</a> (nlohmann::json _sub_json, bool)</td></tr>
<tr class="memdesc:ac11d19096b4e88cb288a208a4953af4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Settings Object object. <a href="classGpgFrontend_1_1UI_1_1SettingsObject.html#ac11d19096b4e88cb288a208a4953af4d">More...</a><br /></td></tr>
<tr class="separator:ac11d19096b4e88cb288a208a4953af4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae71336d240ace35756d1852a46271f6c"><td class="memItemLeft" align="right" valign="top"><a id="ae71336d240ace35756d1852a46271f6c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html#ae71336d240ace35756d1852a46271f6c">~SettingsObject</a> ()</td></tr>
<tr class="memdesc:ae71336d240ace35756d1852a46271f6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the Settings Object object. <br /></td></tr>
<tr class="separator:ae71336d240ace35756d1852a46271f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ddcc2e0bc6d4c2f88e6e00371d4792e"><td class="memItemLeft" align="right" valign="top">nlohmann::json &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html#a5ddcc2e0bc6d4c2f88e6e00371d4792e">Check</a> (const std::string &amp;key, const nlohmann::json &amp;default_value)</td></tr>
<tr class="separator:a5ddcc2e0bc6d4c2f88e6e00371d4792e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80801f6912991ba625b5ead29a4558f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html">SettingsObject</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html#a80801f6912991ba625b5ead29a4558f0">Check</a> (const std::string &amp;key)</td></tr>
<tr class="separator:a80801f6912991ba625b5ead29a4558f0"><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:a69e9027002113bf9ecc16d7836e42c63"><td class="memItemLeft" align="right" valign="top"><a id="a69e9027002113bf9ecc16d7836e42c63"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>settings_name_</b></td></tr>
<tr class="separator:a69e9027002113bf9ecc16d7836e42c63"><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>The <a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html" title="The SettingsObject class This class is used to store settings for the application securely.">SettingsObject</a> class This class is used to store settings for the application securely. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aad706a2c2b68d280b5d3ababff0ff302"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad706a2c2b68d280b5d3ababff0ff302">&#9670;&nbsp;</a></span>SettingsObject() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::UI::SettingsObject::SettingsObject </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>settings_name</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>Construct a new Settings Object object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings_name</td><td>The name of the settings object </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgFrontend::SingletonFunctionObject&lt; DataObjectOperator &gt;::GetInstance()</a>.</p>
</div>
</div>
<a id="ac11d19096b4e88cb288a208a4953af4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac11d19096b4e88cb288a208a4953af4d">&#9670;&nbsp;</a></span>SettingsObject() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::UI::SettingsObject::SettingsObject </td>
<td>(</td>
<td class="paramtype">nlohmann::json&#160;</td>
<td class="paramname"><em>_sub_json</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname">&#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>Construct a new Settings Object object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_sub_json</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a80801f6912991ba625b5ead29a4558f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80801f6912991ba625b5ead29a4558f0">&#9670;&nbsp;</a></span>Check() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html">GpgFrontend::UI::SettingsObject</a> GpgFrontend::UI::SettingsObject::Check </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classGpgFrontend_1_1UI_1_1SettingsObject.html" title="The SettingsObject class This class is used to store settings for the application securely.">SettingsObject</a> </dd></dl>
</div>
</div>
<a id="a5ddcc2e0bc6d4c2f88e6e00371d4792e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ddcc2e0bc6d4c2f88e6e00371d4792e">&#9670;&nbsp;</a></span>Check() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json &amp; GpgFrontend::UI::SettingsObject::Check </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json &amp;&#160;</td>
<td class="paramname"><em>default_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td></td></tr>
<tr><td class="paramname">default_value</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>nlohmann::json&amp;</dd></dl>
<p>Copyright (C) 2021 Saturneric</p>
<p>This file is part of <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>.</p>
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>. If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>
<p>The initial version of the source code is inherited from the gpg4usb project, which is under GPL-3.0-or-later.</p>
<p>All the source code of <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> was modified and released by Saturneric<a href="#" onclick="location.href='mai'+'lto:'+'eri'+'c@'+'bkt'+'us'+'.co'+'m'; return false;">eric@<span style="display: none;">.nosp@m.</span>bktu<span style="display: none;">.nosp@m.</span>s.com</a> starting on May 12, 2021.</p>
<p>SPDX-License-Identifier: GPL-3.0-or-later </p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1KeyServerImportDialog.html#ab9e2fe38d54c0f0d3d73907300faa513">GpgFrontend::UI::KeyServerImportDialog::create_comboBox()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a8759224e57d4c322933ed3df6d96e5f1">GpgFrontend::UI::PlainTextEditorPage::PlainTextEditorPage()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1InfoBoardWidget.html#ac936cfc8e1b3af65d0d71b74fb3f0b02">GpgFrontend::UI::InfoBoardWidget::SetInfoBoard()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1AppearanceTab.html#a2fed39a2657407fcdb37d2431ef28e56">GpgFrontend::UI::AppearanceTab::SetSettings()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1KeyserverTab.html#a221117b56dda48956e44d96a08f6823b">GpgFrontend::UI::KeyserverTab::SetSettings()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#a874b505fbc1046f579a736683f5a7f65">GpgFrontend::UI::MainWindow::slot_open_settings_dialog()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1KeyUploadDialog.html#a0f724649ca953b888f07d69c97fe45b6">GpgFrontend::UI::KeyUploadDialog::slot_upload_key_to_server()</a>, <a class="el" href="classGpgFrontend_1_1UI_1_1KeyServerImportDialog.html#a1e17305d6b470d0f7050eb8e3e6ee3d8">GpgFrontend::UI::KeyServerImportDialog::SlotImport()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1CommonUtils.html#a35a47fc31b81b6c4f5899e8ab5c4c51a">GpgFrontend::UI::CommonUtils::SlotImportKeyFromKeyServer()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ui/struct/<a class="el" href="SettingsObject_8h_source.html">SettingsObject.h</a></li>
<li>src/ui/struct/SettingsObject.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_1SettingsObject.html">SettingsObject</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>
Reference in New Issue View Git Blame Copy Permalink