update netctl-gui docs

This commit is contained in:
arcan1s
2015-06-29 00:13:05 +03:00
parent 3a50b35392
commit 61173774e0
46 changed files with 287 additions and 289 deletions

View File

@ -25,7 +25,7 @@
<td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">netctlgui
&#160;<span id="projectnumber">1.4.5</span>
&#160;<span id="projectnumber">1.4.7</span>
</div>
<div id="projectbrief">Qt library which interacts with netctl</div>
</td>
@ -114,37 +114,39 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;QMap&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;QObject&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_netctl_profile.html"> 37</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_netctl_profile.html">NetctlProfile</a> : <span class="keyword">public</span> QObject</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; Q_OBJECT</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_netctl_profile.html#adbbaf6da0c7325e7477db00efbf646f8">NetctlProfile</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> debugCmd = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> QMap&lt;QString, QString&gt; settings = QMap&lt;QString, QString&gt;());</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="class_netctl_profile.html#a00b3becc7bf1f888500127bcd0cb86c8">~NetctlProfile</a>();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_netctl_profile.html#a3de2d57c7b7e3bf3f743a6332c2971ae">copyProfile</a>(<span class="keyword">const</span> QString oldPath);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; QString <a class="code" href="class_netctl_profile.html#ade8dabcf148c27c1c0f865b6c620ab48">createProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QMap&lt;QString, QString&gt; settings);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">static</span> QMap&lt;QString, QString&gt; <a class="code" href="class_netctl_profile.html#afd4f9bf1ae5725fbb4f85ab32428e01a">getRecommendedConfiguration</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; QMap&lt;QString, QString&gt; <a class="code" href="class_netctl_profile.html#a32c509f71d5a5b2fbf88100f268c152f">getSettingsFromProfile</a>(<span class="keyword">const</span> QString profile);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; QString <a class="code" href="class_netctl_profile.html#a4e9303e64f53c27ed925f13acc7bb8ce">getValueFromProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QString key);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; QStringList <a class="code" href="class_netctl_profile.html#a085178b5f7d705b8613e5bbb9c71bb0e">getValuesFromProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QStringList keys);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_netctl_profile.html#adc032c8203e0e8cef96f0586b8351079">removeProfile</a>(<span class="keyword">const</span> QString profile);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">bool</span> debug = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">bool</span> useSuid = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; QDir *profileDirectory = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; QString sudoCommand = QString(<span class="stringliteral">&quot;/usr/bin/kdesu&quot;</span>);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;};</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* NETCTLPROFILE_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;version.h&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_netctl_profile.html"> 39</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_netctl_profile.html">NetctlProfile</a> : <span class="keyword">public</span> QObject</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;{</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; Q_OBJECT</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_netctl_profile.html#adbbaf6da0c7325e7477db00efbf646f8">NetctlProfile</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> debugCmd = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">const</span> QMap&lt;QString, QString&gt; settings = QMap&lt;QString, QString&gt;());</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="class_netctl_profile.html#a00b3becc7bf1f888500127bcd0cb86c8">~NetctlProfile</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_netctl_profile.html#a3de2d57c7b7e3bf3f743a6332c2971ae">copyProfile</a>(<span class="keyword">const</span> QString oldPath);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; QString <a class="code" href="class_netctl_profile.html#ade8dabcf148c27c1c0f865b6c620ab48">createProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QMap&lt;QString, QString&gt; settings);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">static</span> QMap&lt;QString, QString&gt; <a class="code" href="class_netctl_profile.html#afd4f9bf1ae5725fbb4f85ab32428e01a">getRecommendedConfiguration</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; QMap&lt;QString, QString&gt; <a class="code" href="class_netctl_profile.html#a32c509f71d5a5b2fbf88100f268c152f">getSettingsFromProfile</a>(<span class="keyword">const</span> QString profile);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; QString <a class="code" href="class_netctl_profile.html#a4e9303e64f53c27ed925f13acc7bb8ce">getValueFromProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QString key);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; QStringList <a class="code" href="class_netctl_profile.html#a085178b5f7d705b8613e5bbb9c71bb0e">getValuesFromProfile</a>(<span class="keyword">const</span> QString profile, <span class="keyword">const</span> QStringList keys);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_netctl_profile.html#adc032c8203e0e8cef96f0586b8351079">removeProfile</a>(<span class="keyword">const</span> QString profile);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">bool</span> debug = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">bool</span> useSuid = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; QDir *profileDirectory = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; QString sudoCommand = QString(SUDO_PATH);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;};</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* NETCTLPROFILE_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="class_netctl_profile_html_ade8dabcf148c27c1c0f865b6c620ab48"><div class="ttname"><a href="class_netctl_profile.html#ade8dabcf148c27c1c0f865b6c620ab48">NetctlProfile::createProfile</a></div><div class="ttdeci">QString createProfile(const QString profile, const QMap&lt; QString, QString &gt; settings)</div><div class="ttdoc">method which creates temporary profile </div></div>
<div class="ttc" id="class_netctl_profile_html_a32c509f71d5a5b2fbf88100f268c152f"><div class="ttname"><a href="class_netctl_profile.html#a32c509f71d5a5b2fbf88100f268c152f">NetctlProfile::getSettingsFromProfile</a></div><div class="ttdeci">QMap&lt; QString, QString &gt; getSettingsFromProfile(const QString profile)</div><div class="ttdoc">method which reads settings from profile </div></div>
<div class="ttc" id="class_netctl_profile_html_a4e9303e64f53c27ed925f13acc7bb8ce"><div class="ttname"><a href="class_netctl_profile.html#a4e9303e64f53c27ed925f13acc7bb8ce">NetctlProfile::getValueFromProfile</a></div><div class="ttdeci">QString getValueFromProfile(const QString profile, const QString key)</div><div class="ttdoc">method which return value from profile by key </div></div>
<div class="ttc" id="class_netctl_profile_html_adbbaf6da0c7325e7477db00efbf646f8"><div class="ttname"><a href="class_netctl_profile.html#adbbaf6da0c7325e7477db00efbf646f8">NetctlProfile::NetctlProfile</a></div><div class="ttdeci">NetctlProfile(const bool debugCmd=false, const QMap&lt; QString, QString &gt; settings=QMap&lt; QString, QString &gt;())</div><div class="ttdoc">NetctlProfile class constructor. </div></div>
<div class="ttc" id="class_netctl_profile_html"><div class="ttname"><a href="class_netctl_profile.html">NetctlProfile</a></div><div class="ttdoc">The NetctlProfile class interacts with netctl profiles. </div><div class="ttdef"><b>Definition:</b> netctlprofile.h:37</div></div>
<div class="ttc" id="class_netctl_profile_html"><div class="ttname"><a href="class_netctl_profile.html">NetctlProfile</a></div><div class="ttdoc">The NetctlProfile class interacts with netctl profiles. </div><div class="ttdef"><b>Definition:</b> netctlprofile.h:39</div></div>
<div class="ttc" id="class_netctl_profile_html_afd4f9bf1ae5725fbb4f85ab32428e01a"><div class="ttname"><a href="class_netctl_profile.html#afd4f9bf1ae5725fbb4f85ab32428e01a">NetctlProfile::getRecommendedConfiguration</a></div><div class="ttdeci">static QMap&lt; QString, QString &gt; getRecommendedConfiguration()</div><div class="ttdoc">method which check system configuration and return recommended values to keys </div></div>
<div class="ttc" id="class_netctl_profile_html_a00b3becc7bf1f888500127bcd0cb86c8"><div class="ttname"><a href="class_netctl_profile.html#a00b3becc7bf1f888500127bcd0cb86c8">NetctlProfile::~NetctlProfile</a></div><div class="ttdeci">~NetctlProfile()</div><div class="ttdoc">Netctl class destructor. </div></div>
<div class="ttc" id="class_netctl_profile_html_a3de2d57c7b7e3bf3f743a6332c2971ae"><div class="ttname"><a href="class_netctl_profile.html#a3de2d57c7b7e3bf3f743a6332c2971ae">NetctlProfile::copyProfile</a></div><div class="ttdeci">bool copyProfile(const QString oldPath)</div><div class="ttdoc">method which copies temporary profile to PROFILE_DIR </div></div>
@ -153,7 +155,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 13 2015 00:22:33 for netctlgui by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Jun 28 2015 14:37:53 for netctlgui by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>