update netctl-gui pages

This commit is contained in:
arcan1s
2014-08-25 16:05:45 +04:00
parent 5c1a7ba9d4
commit 5feea0f6dc
83 changed files with 2047 additions and 935 deletions

View File

@ -24,7 +24,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.2.0</span>
&#160;<span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">Qt library which interacts with netctl</div>
</td>
@ -73,7 +73,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
@ -87,6 +87,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_wpa_sup-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">WpaSup Class Reference</div> </div>
@ -106,9 +107,9 @@ Inheritance diagram for WpaSup:</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:a62c61783935fa166c0ab4365bccce6d2"><td class="memItemLeft" align="right" valign="top">QList&lt; QStringList &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wpa_sup.html#a62c61783935fa166c0ab4365bccce6d2">scanWifi</a> ()</td></tr>
<tr class="memdesc:a62c61783935fa166c0ab4365bccce6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which scans WiFi networks <a href="#a62c61783935fa166c0ab4365bccce6d2">More...</a><br /></td></tr>
<tr class="separator:a62c61783935fa166c0ab4365bccce6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf3330fca9041e2cb149dec3da01b46e"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="structnetctl_wifi_info.html">netctlWifiInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wpa_sup.html#abf3330fca9041e2cb149dec3da01b46e">scanWifi</a> ()</td></tr>
<tr class="memdesc:abf3330fca9041e2cb149dec3da01b46e"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which scans WiFi networks <a href="#abf3330fca9041e2cb149dec3da01b46e">More...</a><br /></td></tr>
<tr class="separator:abf3330fca9041e2cb149dec3da01b46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe6865d3fc907dedf0d6eb485123ef0b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wpa_sup.html#abe6865d3fc907dedf0d6eb485123ef0b">startWpaSupplicant</a> ()</td></tr>
<tr class="memdesc:abe6865d3fc907dedf0d6eb485123ef0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which calls wpa_supplicant <a href="#abe6865d3fc907dedf0d6eb485123ef0b">More...</a><br /></td></tr>
<tr class="separator:abe6865d3fc907dedf0d6eb485123ef0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -133,6 +134,12 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:aebc870feafdc0acdee5d9007627ba3d8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wpa_sup.html#aebc870feafdc0acdee5d9007627ba3d8">isProfileExists</a> (const QString essid)</td></tr>
<tr class="memdesc:aebc870feafdc0acdee5d9007627ba3d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks profile existence by ESSID <a href="#aebc870feafdc0acdee5d9007627ba3d8">More...</a><br /></td></tr>
<tr class="separator:aebc870feafdc0acdee5d9007627ba3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab60ec6f1349b09dbdeca9e359dc6a355"><td class="memItemLeft" align="right" valign="top">static QMap&lt; QString, QString &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wpa_sup.html#ab60ec6f1349b09dbdeca9e359dc6a355">getRecommendedConfiguration</a> ()</td></tr>
<tr class="memdesc:ab60ec6f1349b09dbdeca9e359dc6a355"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which check system configuration and return recommended values to keys <a href="#ab60ec6f1349b09dbdeca9e359dc6a355">More...</a><br /></td></tr>
<tr class="separator:ab60ec6f1349b09dbdeca9e359dc6a355"><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="class_wpa_sup.html" title="The WpaSup class interacts with wpa_supplicant. ">WpaSup</a> class interacts with wpa_supplicant. </p>
@ -173,7 +180,7 @@ Public Member Functions</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">debugCmd</td><td>show debug messages </td></tr>
<tr><td class="paramname">settings</td><td>default settings. Needed keys are CTRL_DIR (path to ctrl_directory), CTRL_GROUP (group which is owner of CTRL_DIR), PID_FILE (wpa_supplicant PID file), SUDO_PATH (path to sudo command), WPACLI_PATH (path to wpa_cli command), WPA_DRIVERS (wpa_supplicant drivers comma separated), WPASUP_PATH (path to wpa_supplicant command) </td></tr>
<tr><td class="paramname">settings</td><td>default settings. Needed keys are CTRL_DIR (path to ctrl_directory), CTRL_GROUP (group which is owner of CTRL_DIR), FORCE_SUDO (force to use sudo), PID_FILE (wpa_supplicant PID file), SUDO_PATH (path to sudo command), WPACLI_PATH (path to wpa_cli command), WPA_DRIVERS (wpa_supplicant drivers comma separated), WPASUP_PATH (path to wpa_supplicant command) </td></tr>
</table>
</dd>
</dl>
@ -221,6 +228,32 @@ Public Member Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>profile name </dd></dl>
</div>
</div>
<a class="anchor" id="ab60ec6f1349b09dbdeca9e359dc6a355"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static QMap&lt;QString, QString&gt; WpaSup::getRecommendedConfiguration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>method which check system configuration and return recommended values to keys </p>
<dl class="section return"><dt>Returns</dt><dd>recommended parametrs </dd></dl>
</div>
</div>
<a class="anchor" id="a84e2b4cb1d25d21379e0fc860a7fb9a4"></a>
@ -277,7 +310,7 @@ true if profile exists </dd></dl>
</div>
</div>
<a class="anchor" id="a62c61783935fa166c0ab4365bccce6d2"></a>
<a class="anchor" id="abf3330fca9041e2cb149dec3da01b46e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
@ -285,7 +318,7 @@ true if profile exists </dd></dl>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QList&lt;QStringList&gt; WpaSup::scanWifi </td>
<td class="memname">QList&lt;<a class="el" href="structnetctl_wifi_info.html">netctlWifiInfo</a>&gt; WpaSup::scanWifi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@ -299,7 +332,7 @@ true if profile exists </dd></dl>
</div><div class="memdoc">
<p>method which scans WiFi networks </p>
<dl class="section return"><dt>Returns</dt><dd>list of essids. Available information is [NAME, NETCTL_STATUS, SIGNAL, SECUITY]: NAME is WiFi point name or "&lt;hidden&gt;", NETCTL_STATUS may be "new", "exist (active)", "exist (inactive)", SIGNAL is Wifi point signal, SECURITY may be "WPA2", "WEP", "WEP", "none" </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>list of essids </dd></dl>
</div>
</div>
@ -365,7 +398,7 @@ true if the method was completed without errors </dd></dl>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 30 2014 19:20:33 for netctlgui by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Aug 25 2014 15:07:08 for netctlgui by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>