Migration of QtMvvm from github
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

156 lines
13 KiB

<!-- HTML header for doxygen 1.8.13-->
<!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>QtMvvm: QtMvvm::SettingsEntry&lt; T &gt; Class Template 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="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" style="display: inline;">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">QtMvvm
&#160;<span id="projectnumber">1.1.0</span>
</div>
<div id="projectbrief">A mvvm oriented library for Qt, to create Projects for Widgets and Quick in parallel</div>
</td>
</tr>
</tbody>
</table>
<a style="float: right;" target="_blank" href="https://github.com/Skycoder42/QtMvvm">
<img style="padding: 10px;" src="GitHub_Logo.png"/>
</a>
</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_qt_mvvm.html">QtMvvm</a></li><li class="navelem"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html">SettingsEntry</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_qt_mvvm_1_1_settings_entry-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QtMvvm::SettingsEntry&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A generic wrapper around <a class="el" href="class_qt_mvvm_1_1_i_settings_accessor.html" title="An interface to provide a generic way to access settings of any origin. ">ISettingsAccessor</a> used by the <a class="el" href="settings_generator.html">qsettingsgenerator</a>.
<a href="class_qt_mvvm_1_1_settings_entry.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="settingsentry_8h_source.html">settingsentry.h</a>&gt;</code></p>
<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:a472f6f0e30294ed960a7504384aa51b6"><td class="memItemLeft" align="right" valign="top"><a id="a472f6f0e30294ed960a7504384aa51b6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a472f6f0e30294ed960a7504384aa51b6">isSet</a> () const</td></tr>
<tr class="memdesc:a472f6f0e30294ed960a7504384aa51b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the entry is stored in the settings. <br /></td></tr>
<tr class="separator:a472f6f0e30294ed960a7504384aa51b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadcf907bad726d60a474008d58344da4"><td class="memItemLeft" align="right" valign="top"><a id="aadcf907bad726d60a474008d58344da4"></a>
<a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtcore/qtcore.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/qstring.html">QString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#aadcf907bad726d60a474008d58344da4">key</a> () const</td></tr>
<tr class="memdesc:aadcf907bad726d60a474008d58344da4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the key this entry uses to access the settings. <br /></td></tr>
<tr class="separator:aadcf907bad726d60a474008d58344da4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99230b611983fb72ca3b65c9ac34e2fd"><td class="memItemLeft" align="right" valign="top"><a id="a99230b611983fb72ca3b65c9ac34e2fd"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a99230b611983fb72ca3b65c9ac34e2fd">get</a> () const</td></tr>
<tr class="memdesc:a99230b611983fb72ca3b65c9ac34e2fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the value from the settings. <br /></td></tr>
<tr class="separator:a99230b611983fb72ca3b65c9ac34e2fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23efc7c45f1f02f4e7b280f9a4ec68d7"><td class="memItemLeft" align="right" valign="top"><a id="a23efc7c45f1f02f4e7b280f9a4ec68d7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a23efc7c45f1f02f4e7b280f9a4ec68d7">set</a> (const T &amp;value)</td></tr>
<tr class="memdesc:a23efc7c45f1f02f4e7b280f9a4ec68d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the passed value in the settings. <br /></td></tr>
<tr class="separator:a23efc7c45f1f02f4e7b280f9a4ec68d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d79faf59f10763f0a8fa3ea854f985b"><td class="memItemLeft" align="right" valign="top"><a id="a7d79faf59f10763f0a8fa3ea854f985b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a7d79faf59f10763f0a8fa3ea854f985b">reset</a> ()</td></tr>
<tr class="memdesc:a7d79faf59f10763f0a8fa3ea854f985b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the entry and all child entries from the settings. <br /></td></tr>
<tr class="separator:a7d79faf59f10763f0a8fa3ea854f985b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac84435eb0308f12f4159001c6b437fa1"><td class="memItemLeft" align="right" valign="top"><a id="ac84435eb0308f12f4159001c6b437fa1"></a>
<a class="el" href="class_qt_mvvm_1_1_settings_entry.html">SettingsEntry</a>&lt; T &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#ac84435eb0308f12f4159001c6b437fa1">operator=</a> (const T &amp;value)</td></tr>
<tr class="memdesc:ac84435eb0308f12f4159001c6b437fa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the passed value in the settings. <br /></td></tr>
<tr class="separator:ac84435eb0308f12f4159001c6b437fa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c26e6ab0e1f7227e3d8146cd6bb47b"><td class="memItemLeft" align="right" valign="top"><a id="a45c26e6ab0e1f7227e3d8146cd6bb47b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a45c26e6ab0e1f7227e3d8146cd6bb47b">operator T</a> () const</td></tr>
<tr class="memdesc:a45c26e6ab0e1f7227e3d8146cd6bb47b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the value from the settings. <br /></td></tr>
<tr class="separator:a45c26e6ab0e1f7227e3d8146cd6bb47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334688185de9b56cf2702def7aa01c17"><td class="memItemLeft" align="right" valign="top"><a id="a334688185de9b56cf2702def7aa01c17"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a334688185de9b56cf2702def7aa01c17">addChangeCallback</a> (const std::function&lt; void(T)&gt; &amp;callback)</td></tr>
<tr class="memdesc:a334688185de9b56cf2702def7aa01c17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a method to be called if the entries value changes. <br /></td></tr>
<tr class="separator:a334688185de9b56cf2702def7aa01c17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f3996b9823c25acebb0ac70a673a1f1"><td class="memItemLeft" align="right" valign="top"><a id="a3f3996b9823c25acebb0ac70a673a1f1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qt_mvvm_1_1_settings_entry.html#a3f3996b9823c25acebb0ac70a673a1f1">addChangeCallback</a> (<a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtautoupdater/qtautoupdater.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/class_q_object.html">QObject</a> *scope, const std::function&lt; void(T)&gt; &amp;callback)</td></tr>
<tr class="memdesc:a3f3996b9823c25acebb0ac70a673a1f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a method to be called if the entries value changes, as long as scope exists. <br /></td></tr>
<tr class="separator:a3f3996b9823c25acebb0ac70a673a1f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49dc1726185c0922986fc12e2818c452"><td class="memTemplParams" colspan="2"><a id="a49dc1726185c0922986fc12e2818c452"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a49dc1726185c0922986fc12e2818c452"><td class="memTemplItemLeft" align="right" valign="top">Q_MVVMCORE_EXPORT <a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtcore/qtcore.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/qvariant.html">QVariant</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>get</b> () const</td></tr>
<tr class="separator:a49dc1726185c0922986fc12e2818c452"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa019c0378464ec9375ab24db928d03b8"><td class="memTemplParams" colspan="2"><a id="aa019c0378464ec9375ab24db928d03b8"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:aa019c0378464ec9375ab24db928d03b8"><td class="memTemplItemLeft" align="right" valign="top">Q_MVVMCORE_EXPORT void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>set</b> (const <a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtcore/qtcore.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/qvariant.html">QVariant</a> &amp;value)</td></tr>
<tr class="separator:aa019c0378464ec9375ab24db928d03b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98d8813bf17be417f9611366f88f5cf8"><td class="memTemplParams" colspan="2"><a id="a98d8813bf17be417f9611366f88f5cf8"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a98d8813bf17be417f9611366f88f5cf8"><td class="memTemplItemLeft" align="right" valign="top">Q_MVVMCORE_EXPORT void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>addChangeCallback</b> (<a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtautoupdater/qtautoupdater.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/class_q_object.html">QObject</a> *scope, const std::function&lt; void(<a class="elRef" target="_blank" doxygen="/home/sky/Qt/Docs/Qt-5.11.1/qtcore/qtcore.tags:https://doc.qt.io/qt-5/" href="https://doc.qt.io/qt-5/qvariant.html">QVariant</a>)&gt; &amp;callback)</td></tr>
<tr class="separator:a98d8813bf17be417f9611366f88f5cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class QtMvvm::SettingsEntry&lt; T &gt;</h3>
<p>A generic wrapper around <a class="el" href="class_qt_mvvm_1_1_i_settings_accessor.html" title="An interface to provide a generic way to access settings of any origin. ">ISettingsAccessor</a> used by the <a class="el" href="settings_generator.html">qsettingsgenerator</a>. </p>
<p class="definition">Definition at line <a class="el" href="settingsentry_8h_source.html#l00018">18</a> of file <a class="el" href="settingsentry_8h_source.html">settingsentry.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="settingsentry_8h_source.html">settingsentry.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 8 2018 19:15:45 for QtMvvm by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>