Add www pages
[urpo] / www / apidoc / html / class_urpo_connection_settings.html
diff --git a/www/apidoc/html/class_urpo_connection_settings.html b/www/apidoc/html/class_urpo_connection_settings.html
new file mode 100644 (file)
index 0000000..65b6b9a
--- /dev/null
@@ -0,0 +1,228 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!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"/>
+<title>Urpo: UrpoConnectionSettings Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;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">
+        <img id="MSearchSelect" src="search/search.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)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>UrpoConnectionSettings Class Reference</h1><!-- doxytag: class="UrpoConnectionSettings" --><!-- doxytag: inherits="UrpoConnection" -->
+<p>Connection information, support storing settings.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="urpoconnectionsettings_8h_source.html">urpoconnectionsettings.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for UrpoConnectionSettings:</div>
+<div class="dynsection">
+ <div class="center">
+  <img src="class_urpo_connection_settings.png" usemap="#UrpoConnectionSettings_map" alt=""/>
+  <map id="UrpoConnectionSettings_map" name="UrpoConnectionSettings_map">
+<area href="class_urpo_connection.html" alt="UrpoConnection" shape="rect" coords="0,0,147,24"/>
+</map>
+ </div>
+</div>
+
+<p><a href="class_urpo_connection_settings-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a4d6b405e37d84d891d439087eaa196c8">UrpoConnectionSettings</a> (const QString organization=QString(), const QString application=QString())</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a2b24ed1467e465c776b8fc9fea398ba3">getHost</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host name or ip address.  <a href="#a2b24ed1467e465c776b8fc9fea398ba3"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#af929c71f228d34ef86a0f940aa7910ae">getIdentity</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identity file.  <a href="#af929c71f228d34ef86a0f940aa7910ae"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a628e651c01d58bd283308fab9aba98be">getUserid</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Userid in server.  <a href="#a628e651c01d58bd283308fab9aba98be"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8f162e99ebc0d33895e6232df31d018"></a><!-- doxytag: member="UrpoConnectionSettings::setHost" ref="ad8f162e99ebc0d33895e6232df31d018" args="(const QString &amp;host)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setHost</b> (const QString &amp;host)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a581193fad8b8d58a12bc8d4ffa9c7fd1"></a><!-- doxytag: member="UrpoConnectionSettings::setIdentity" ref="a581193fad8b8d58a12bc8d4ffa9c7fd1" args="(const QString &amp;password)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setIdentity</b> (const QString &amp;password)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63738024bd08e5c8d8e3944fb050f8ea"></a><!-- doxytag: member="UrpoConnectionSettings::setUserid" ref="a63738024bd08e5c8d8e3944fb050f8ea" args="(const QString &amp;userid)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setUserid</b> (const QString &amp;userid)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e61e966401d23fd3be80438e1d36dc"></a><!-- doxytag: member="UrpoConnectionSettings::store" ref="a72e61e966401d23fd3be80438e1d36dc" args="() const " -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a72e61e966401d23fd3be80438e1d36dc">store</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Store settings via QSettings. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26ee65650e3dac5508ab99ee2a591cb2"></a><!-- doxytag: member="UrpoConnectionSettings::load" ref="a26ee65650e3dac5508ab99ee2a591cb2" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a26ee65650e3dac5508ab99ee2a591cb2">load</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load settings via QSettings. <br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Connection information, support storing settings. </p>
+<p>Setting are stored/loaded using QSettings</p>
+<dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
+<dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
+<dl class="version"><dt><b>Version:</b></dt><dd>1 </dd></dl>
+
+<p>Definition at line <a class="el" href="urpoconnectionsettings_8h_source.html#l00036">36</a> of file <a class="el" href="urpoconnectionsettings_8h_source.html">urpoconnectionsettings.h</a>.</p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a4d6b405e37d84d891d439087eaa196c8"></a><!-- doxytag: member="UrpoConnectionSettings::UrpoConnectionSettings" ref="a4d6b405e37d84d891d439087eaa196c8" args="(const QString organization=QString(), const QString application=QString())" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">UrpoConnectionSettings::UrpoConnectionSettings </td>
+          <td>(</td>
+          <td class="paramtype">const QString&nbsp;</td>
+          <td class="paramname"> <em>organization</em> = <code>QString()</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const QString&nbsp;</td>
+          <td class="paramname"> <em>application</em> = <code>QString()</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>organization</em>&nbsp;</td><td>Organization key for storing settings </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>application</em>&nbsp;</td><td>Application key for storing settings </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p>Definition at line <a class="el" href="urpoconnectionsettings_8cpp_source.html#l00027">27</a> of file <a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a2b24ed1467e465c776b8fc9fea398ba3"></a><!-- doxytag: member="UrpoConnectionSettings::getHost" ref="a2b24ed1467e465c776b8fc9fea398ba3" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QString UrpoConnectionSettings::getHost </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Host name or ip address. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Server host name of ip address </dd></dl>
+
+<p>Implements <a class="el" href="class_urpo_connection.html#acfaef63e321ad056ef6da06772967c3b">UrpoConnection</a>.</p>
+
+<p>Definition at line <a class="el" href="urpoconnectionsettings_8cpp_source.html#l00034">34</a> of file <a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="af929c71f228d34ef86a0f940aa7910ae"></a><!-- doxytag: member="UrpoConnectionSettings::getIdentity" ref="af929c71f228d34ef86a0f940aa7910ae" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QString UrpoConnectionSettings::getIdentity </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Identity file. </p>
+<p>ssh identity file (private key)</p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>ssh identity file path </dd></dl>
+
+<p>Implements <a class="el" href="class_urpo_connection.html#ade5d637438a69724385e268fe32d989c">UrpoConnection</a>.</p>
+
+<p>Definition at line <a class="el" href="urpoconnectionsettings_8cpp_source.html#l00039">39</a> of file <a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a628e651c01d58bd283308fab9aba98be"></a><!-- doxytag: member="UrpoConnectionSettings::getUserid" ref="a628e651c01d58bd283308fab9aba98be" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QString UrpoConnectionSettings::getUserid </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Userid in server. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>userid in server </dd></dl>
+
+<p>Implements <a class="el" href="class_urpo_connection.html#aba99d8ff49fffbca8346d54adf244c84">UrpoConnection</a>.</p>
+
+<p>Definition at line <a class="el" href="urpoconnectionsettings_8cpp_source.html#l00044">44</a> of file <a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoconnectionsettings_8h_source.html">urpoconnectionsettings.h</a></li>
+<li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>