arcanis.me/devs/netctl-gui/class_netctl.html
arcan1s c054b4b712 add support of dev docs to projects
add dev docs to some projects
2014-07-30 19:32:13 +04:00

881 lines
42 KiB
HTML

<!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.7"/>
<title>netctlgui: Netctl 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="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>
</div>
<div id="projectbrief">Qt library which interacts with netctl</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_netctl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Netctl Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class interacts with netctl.
<a href="class_netctl.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Netctl:</div>
<div class="dyncontent">
<div class="center">
<img src="class_netctl.png" usemap="#Netctl_map" alt=""/>
<map id="Netctl_map" name="Netctl_map">
</map>
</div></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:a237675bbe56f98df70fa787d9b7a8fca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a237675bbe56f98df70fa787d9b7a8fca">enableProfile</a> (const QString profile)</td></tr>
<tr class="memdesc:a237675bbe56f98df70fa787d9b7a8fca"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which sets profile disabled or enabled <a href="#a237675bbe56f98df70fa787d9b7a8fca">More...</a><br /></td></tr>
<tr class="separator:a237675bbe56f98df70fa787d9b7a8fca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebbaf936349a229239b59eafcb17e4f7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#aebbaf936349a229239b59eafcb17e4f7">restartProfile</a> (const QString profile)</td></tr>
<tr class="memdesc:aebbaf936349a229239b59eafcb17e4f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which restarts profile <a href="#aebbaf936349a229239b59eafcb17e4f7">More...</a><br /></td></tr>
<tr class="separator:aebbaf936349a229239b59eafcb17e4f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6a547515b76b9c7b26170da3a2f39d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#adc6a547515b76b9c7b26170da3a2f39d">startProfile</a> (const QString profile)</td></tr>
<tr class="memdesc:adc6a547515b76b9c7b26170da3a2f39d"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which starts or stops profile <a href="#adc6a547515b76b9c7b26170da3a2f39d">More...</a><br /></td></tr>
<tr class="separator:adc6a547515b76b9c7b26170da3a2f39d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa980954693549f3b5531a43cda23adec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#aa980954693549f3b5531a43cda23adec">autoDisableAllProfiles</a> ()</td></tr>
<tr class="memdesc:aa980954693549f3b5531a43cda23adec"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which sets all profiles disabled (netctl-auto) <a href="#aa980954693549f3b5531a43cda23adec">More...</a><br /></td></tr>
<tr class="separator:aa980954693549f3b5531a43cda23adec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0799dcbb0dec95ca33eb45fbda96b1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a9e0799dcbb0dec95ca33eb45fbda96b1">autoEnableProfile</a> (const QString profile)</td></tr>
<tr class="memdesc:a9e0799dcbb0dec95ca33eb45fbda96b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which sets profile disabled or enabled (netctl-auto) <a href="#a9e0799dcbb0dec95ca33eb45fbda96b1">More...</a><br /></td></tr>
<tr class="separator:a9e0799dcbb0dec95ca33eb45fbda96b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9662e47827403c08d4f67b179d437f14"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a9662e47827403c08d4f67b179d437f14">autoEnableAllProfiles</a> ()</td></tr>
<tr class="memdesc:a9662e47827403c08d4f67b179d437f14"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which sets all profiles enabled (netctl-auto) <a href="#a9662e47827403c08d4f67b179d437f14">More...</a><br /></td></tr>
<tr class="separator:a9662e47827403c08d4f67b179d437f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6d259774703f3a78c7d0ce585f3a4f9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#ad6d259774703f3a78c7d0ce585f3a4f9">autoStartProfile</a> (const QString profile)</td></tr>
<tr class="memdesc:ad6d259774703f3a78c7d0ce585f3a4f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which switchs to profile (netctl-auto) <a href="#ad6d259774703f3a78c7d0ce585f3a4f9">More...</a><br /></td></tr>
<tr class="separator:ad6d259774703f3a78c7d0ce585f3a4f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55690068a9b0afb425fc659b3a558f5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a55690068a9b0afb425fc659b3a558f5f">autoEnableService</a> ()</td></tr>
<tr class="memdesc:a55690068a9b0afb425fc659b3a558f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which sets netctl-auto service enabled or disabled <a href="#a55690068a9b0afb425fc659b3a558f5f">More...</a><br /></td></tr>
<tr class="separator:a55690068a9b0afb425fc659b3a558f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f9f5131cce695fe0a26adbc7be68fa3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a1f9f5131cce695fe0a26adbc7be68fa3">autoRestartService</a> ()</td></tr>
<tr class="memdesc:a1f9f5131cce695fe0a26adbc7be68fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which restarted netctl-auto service <a href="#a1f9f5131cce695fe0a26adbc7be68fa3">More...</a><br /></td></tr>
<tr class="separator:a1f9f5131cce695fe0a26adbc7be68fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98c3237c7e06c72dc7b9edb4963392f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a98c3237c7e06c72dc7b9edb4963392f5">autoStartService</a> ()</td></tr>
<tr class="memdesc:a98c3237c7e06c72dc7b9edb4963392f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which starts or stops netctl-auto service <a href="#a98c3237c7e06c72dc7b9edb4963392f5">More...</a><br /></td></tr>
<tr class="separator:a98c3237c7e06c72dc7b9edb4963392f5"><td class="memSeparator" colspan="2">&#160;</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:a63fe336271242547aa097e0ac8cb81a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a63fe336271242547aa097e0ac8cb81a9">Netctl</a> (const bool debugCmd=false, const QMap&lt; QString, QString &gt; settings=QMap&lt; QString, QString &gt;())</td></tr>
<tr class="memdesc:a63fe336271242547aa097e0ac8cb81a9"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class constructor. <a href="#a63fe336271242547aa097e0ac8cb81a9">More...</a><br /></td></tr>
<tr class="separator:a63fe336271242547aa097e0ac8cb81a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad148c9999a03a65f67a9e097e3b56ec0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#ad148c9999a03a65f67a9e097e3b56ec0">~Netctl</a> ()</td></tr>
<tr class="memdesc:ad148c9999a03a65f67a9e097e3b56ec0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class destructor. <a href="#ad148c9999a03a65f67a9e097e3b56ec0">More...</a><br /></td></tr>
<tr class="separator:ad148c9999a03a65f67a9e097e3b56ec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17ead46c74cf7271078bcaa03f643f2"><td class="memItemLeft" align="right" valign="top">QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#ad17ead46c74cf7271078bcaa03f643f2">getInterfaceList</a> ()</td></tr>
<tr class="memdesc:ad17ead46c74cf7271078bcaa03f643f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which gets interface list from PREFERED_IFACE and IFACE_DIR <a href="#ad17ead46c74cf7271078bcaa03f643f2">More...</a><br /></td></tr>
<tr class="separator:ad17ead46c74cf7271078bcaa03f643f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a977402c158d3b8af68a8fd726b3f2e6a"><td class="memItemLeft" align="right" valign="top">QList&lt; QStringList &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a977402c158d3b8af68a8fd726b3f2e6a">getProfileList</a> ()</td></tr>
<tr class="memdesc:a977402c158d3b8af68a8fd726b3f2e6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which returns profile informations from netctl <a href="#a977402c158d3b8af68a8fd726b3f2e6a">More...</a><br /></td></tr>
<tr class="separator:a977402c158d3b8af68a8fd726b3f2e6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b96fb759fcfe60564620a2dae0a4e7e"><td class="memItemLeft" align="right" valign="top">QList&lt; QStringList &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a0b96fb759fcfe60564620a2dae0a4e7e">getProfileListFromNetctlAuto</a> ()</td></tr>
<tr class="memdesc:a0b96fb759fcfe60564620a2dae0a4e7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which returns profile informations from netctl-auto <a href="#a0b96fb759fcfe60564620a2dae0a4e7e">More...</a><br /></td></tr>
<tr class="separator:a0b96fb759fcfe60564620a2dae0a4e7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d22999dfc83293aed4f272ce9bcac03"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a8d22999dfc83293aed4f272ce9bcac03">getProfileDescription</a> (const QString profile)</td></tr>
<tr class="memdesc:a8d22999dfc83293aed4f272ce9bcac03"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which gets description from profile <a href="#a8d22999dfc83293aed4f272ce9bcac03">More...</a><br /></td></tr>
<tr class="separator:a8d22999dfc83293aed4f272ce9bcac03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57a2b38db1f006c73dcf783705a086be"><td class="memItemLeft" align="right" valign="top">QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a57a2b38db1f006c73dcf783705a086be">getProfileDescriptions</a> (const QStringList profileList)</td></tr>
<tr class="memdesc:a57a2b38db1f006c73dcf783705a086be"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which gets descriptions from profile list <a href="#a57a2b38db1f006c73dcf783705a086be">More...</a><br /></td></tr>
<tr class="separator:a57a2b38db1f006c73dcf783705a086be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae328363bbcbda4d951a09f31dc5fe570"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#ae328363bbcbda4d951a09f31dc5fe570">getProfileStatus</a> (const QString profile)</td></tr>
<tr class="memdesc:ae328363bbcbda4d951a09f31dc5fe570"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which gets profile status <a href="#ae328363bbcbda4d951a09f31dc5fe570">More...</a><br /></td></tr>
<tr class="separator:ae328363bbcbda4d951a09f31dc5fe570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87cfaee8b2d2813d02c2d0f516cabbad"><td class="memItemLeft" align="right" valign="top">QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a87cfaee8b2d2813d02c2d0f516cabbad">getProfileStatuses</a> (const QStringList profileList)</td></tr>
<tr class="memdesc:a87cfaee8b2d2813d02c2d0f516cabbad"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which gets statuses of profile list <a href="#a87cfaee8b2d2813d02c2d0f516cabbad">More...</a><br /></td></tr>
<tr class="separator:a87cfaee8b2d2813d02c2d0f516cabbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a788c98b484dd49b774e5e4fd3ee98326"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a788c98b484dd49b774e5e4fd3ee98326">isProfileActive</a> (const QString profile)</td></tr>
<tr class="memdesc:a788c98b484dd49b774e5e4fd3ee98326"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks if profile is active <a href="#a788c98b484dd49b774e5e4fd3ee98326">More...</a><br /></td></tr>
<tr class="separator:a788c98b484dd49b774e5e4fd3ee98326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accd1fca26390a148adb1c3aee2fecbf4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#accd1fca26390a148adb1c3aee2fecbf4">isProfileEnabled</a> (const QString profile)</td></tr>
<tr class="memdesc:accd1fca26390a148adb1c3aee2fecbf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks if profile is enabled <a href="#accd1fca26390a148adb1c3aee2fecbf4">More...</a><br /></td></tr>
<tr class="separator:accd1fca26390a148adb1c3aee2fecbf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9eeafe65785ce097634cc3d6dfc8d9ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a9eeafe65785ce097634cc3d6dfc8d9ac">autoIsProfileActive</a> (const QString profile)</td></tr>
<tr class="memdesc:a9eeafe65785ce097634cc3d6dfc8d9ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks if profile is active (netctl-auto) <a href="#a9eeafe65785ce097634cc3d6dfc8d9ac">More...</a><br /></td></tr>
<tr class="separator:a9eeafe65785ce097634cc3d6dfc8d9ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb3ccd5ffc93684ef45b293ed30e2e71"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#aeb3ccd5ffc93684ef45b293ed30e2e71">autoIsProfileEnabled</a> (const QString profile)</td></tr>
<tr class="memdesc:aeb3ccd5ffc93684ef45b293ed30e2e71"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks if profile is enabled (netctl-auto) <a href="#aeb3ccd5ffc93684ef45b293ed30e2e71">More...</a><br /></td></tr>
<tr class="separator:aeb3ccd5ffc93684ef45b293ed30e2e71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad86fc14aa2a20d4f1d6ceaa29d1d582a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#ad86fc14aa2a20d4f1d6ceaa29d1d582a">isNetctlAutoEnabled</a> ()</td></tr>
<tr class="memdesc:ad86fc14aa2a20d4f1d6ceaa29d1d582a"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks netctl-auto autoload status <a href="#ad86fc14aa2a20d4f1d6ceaa29d1d582a">More...</a><br /></td></tr>
<tr class="separator:ad86fc14aa2a20d4f1d6ceaa29d1d582a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38fe28973167cf9853d97947a0e432ce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_netctl.html#a38fe28973167cf9853d97947a0e432ce">isNetctlAutoRunning</a> ()</td></tr>
<tr class="memdesc:a38fe28973167cf9853d97947a0e432ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">method which checks netctl-auto status <a href="#a38fe28973167cf9853d97947a0e432ce">More...</a><br /></td></tr>
<tr class="separator:a38fe28973167cf9853d97947a0e432ce"><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_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class interacts with netctl. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a63fe336271242547aa097e0ac8cb81a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Netctl::Netctl </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>debugCmd</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap&lt; QString, QString &gt;&#160;</td>
<td class="paramname"><em>settings</em> = <code>QMap&lt;&#160;QString,&#160;QString&#160;&gt;()</code>&#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><a class="el" href="class_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class constructor. </p>
<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 IFACE_DIR (path to directory with interfaces), PREFERED_IFACE (prefered interface for WiFi), NETCTL_PATH (path to netctl command), NETCTLAUTO_PATH (path to netctl-auto command), NETCTLAUTO_SERVICE (netctl-auto service name), PROFILE_DIR (path to directory which contains profiles), SUDO_PATH (path to sudo command), SYSTEMCTL_PATH (path to systemctl command) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad148c9999a03a65f67a9e097e3b56ec0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Netctl::~Netctl </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_netctl.html" title="The Netctl class interacts with netctl. ">Netctl</a> class destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa980954693549f3b5531a43cda23adec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoDisableAllProfiles </td>
<td>(</td>
<td class="paramname"></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">
<p>method which sets all profiles disabled (netctl-auto) </p>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a9662e47827403c08d4f67b179d437f14"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoEnableAllProfiles </td>
<td>(</td>
<td class="paramname"></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">
<p>method which sets all profiles enabled (netctl-auto) </p>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a9e0799dcbb0dec95ca33eb45fbda96b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoEnableProfile </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</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">
<p>method which sets profile disabled or enabled (netctl-auto) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a55690068a9b0afb425fc659b3a558f5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoEnableService </td>
<td>(</td>
<td class="paramname"></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">
<p>method which sets netctl-auto service enabled or disabled </p>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a9eeafe65785ce097634cc3d6dfc8d9ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoIsProfileActive </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks if profile is active (netctl-auto) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if profile is inactive </dd>
<dd>
true if profile is active </dd></dl>
</div>
</div>
<a class="anchor" id="aeb3ccd5ffc93684ef45b293ed30e2e71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoIsProfileEnabled </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks if profile is enabled (netctl-auto) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if profile is disabled </dd>
<dd>
true if profile is enabled </dd></dl>
</div>
</div>
<a class="anchor" id="a1f9f5131cce695fe0a26adbc7be68fa3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoRestartService </td>
<td>(</td>
<td class="paramname"></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">
<p>method which restarted netctl-auto service </p>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="ad6d259774703f3a78c7d0ce585f3a4f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoStartProfile </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</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">
<p>method which switchs to profile (netctl-auto) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a98c3237c7e06c72dc7b9edb4963392f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::autoStartService </td>
<td>(</td>
<td class="paramname"></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">
<p>method which starts or stops netctl-auto service </p>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="a237675bbe56f98df70fa787d9b7a8fca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::enableProfile </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</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">
<p>method which sets profile disabled or enabled </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="ad17ead46c74cf7271078bcaa03f643f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QStringList Netctl::getInterfaceList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which gets interface list from PREFERED_IFACE and IFACE_DIR </p>
<dl class="section return"><dt>Returns</dt><dd>interface list. If PREFERED_IFACE is not empty it will be first element </dd></dl>
</div>
</div>
<a class="anchor" id="a8d22999dfc83293aed4f272ce9bcac03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Netctl::getProfileDescription </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which gets description from profile </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>profile description or "" </dd></dl>
</div>
</div>
<a class="anchor" id="a57a2b38db1f006c73dcf783705a086be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QStringList Netctl::getProfileDescriptions </td>
<td>(</td>
<td class="paramtype">const QStringList&#160;</td>
<td class="paramname"><em>profileList</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which gets descriptions from profile list </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profileList</td><td>profile names </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>list of profile descriptions (if description is not available returns "") </dd></dl>
</div>
</div>
<a class="anchor" id="a977402c158d3b8af68a8fd726b3f2e6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QList&lt;QStringList&gt; Netctl::getProfileList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which returns profile informations from netctl </p>
<dl class="section return"><dt>Returns</dt><dd>list of profiles. Available information is [NAME, DESCRIPTION, STATUS]: NAME is a profile name, DESCRIPTION is a profile description (see more details below), STATUS is a profile status (see more details below) </dd></dl>
</div>
</div>
<a class="anchor" id="a0b96fb759fcfe60564620a2dae0a4e7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QList&lt;QStringList&gt; Netctl::getProfileListFromNetctlAuto </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which returns profile informations from netctl-auto </p>
<dl class="section return"><dt>Returns</dt><dd>list of profiles. Available information is [NAME, DESCRIPTION, STATUS]: NAME is a profile name, DESCRIPTION is a profile description (see more details below), STATUS is a profile status (see more details below) </dd></dl>
</div>
</div>
<a class="anchor" id="ae328363bbcbda4d951a09f31dc5fe570"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Netctl::getProfileStatus </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which gets profile status </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>profile status. It may be "active (enabled)", "active (static)", "inactive (enabled)", "inactive (static)" </dd></dl>
</div>
</div>
<a class="anchor" id="a87cfaee8b2d2813d02c2d0f516cabbad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QStringList Netctl::getProfileStatuses </td>
<td>(</td>
<td class="paramtype">const QStringList&#160;</td>
<td class="paramname"><em>profileList</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which gets statuses of profile list </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profileList</td><td>profile names </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>list of profile statuses. It may be "active (enabled)", "active (static)", "inactive (enabled)", "inactive (static)" </dd></dl>
</div>
</div>
<a class="anchor" id="ad86fc14aa2a20d4f1d6ceaa29d1d582a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::isNetctlAutoEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks netctl-auto autoload status </p>
<dl class="section return"><dt>Returns</dt><dd>false if netctl-auto is disabled </dd>
<dd>
true if netctl-auto is enabled </dd></dl>
</div>
</div>
<a class="anchor" id="a38fe28973167cf9853d97947a0e432ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::isNetctlAutoRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks netctl-auto status </p>
<dl class="section return"><dt>Returns</dt><dd>false if netctl-auto is inactive </dd>
<dd>
true if netctl-auto is active </dd></dl>
</div>
</div>
<a class="anchor" id="a788c98b484dd49b774e5e4fd3ee98326"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::isProfileActive </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks if profile is active </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if profile is inactive </dd>
<dd>
true if profile is active </dd></dl>
</div>
</div>
<a class="anchor" id="accd1fca26390a148adb1c3aee2fecbf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Netctl::isProfileEnabled </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>method which checks if profile is enabled </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if profile is disabled </dd>
<dd>
true if profile is enabled </dd></dl>
</div>
</div>
<a class="anchor" id="aebbaf936349a229239b59eafcb17e4f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::restartProfile </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</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">
<p>method which restarts profile </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<a class="anchor" id="adc6a547515b76b9c7b26170da3a2f39d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Netctl::startProfile </td>
<td>(</td>
<td class="paramtype">const QString&#160;</td>
<td class="paramname"><em>profile</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">
<p>method which starts or stops profile </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>profile name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if components are not found or command exit code is not equal to 0 </dd>
<dd>
true if the method was completed without errors </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="netctlinteract_8h_source.html">netctlinteract.h</a></li>
</ul>
</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">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>