Add www pages
[urpo] / www / apidoc / html / class_urpo_connection_settings.html
1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <title>Urpo: UrpoConnectionSettings Class Reference</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javaScript" src="search/search.js"></script>
10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
11 </head>
12 <body onload='searchBox.OnSelectItem(0);'>
13 <!-- Generated by Doxygen 1.6.3 -->
14 <script type="text/javascript"><!--
15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
16 --></script>
17 <div class="navigation" id="top">
18   <div class="tabs">
19     <ul>
20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
22       <li><a href="files.html"><span>Files</span></a></li>
23       <li>
24         <div id="MSearchBox" class="MSearchBoxInactive">
25         <img id="MSearchSelect" src="search/search.png"
26              onmouseover="return searchBox.OnSearchSelectShow()"
27              onmouseout="return searchBox.OnSearchSelectHide()"
28              alt=""/>
29         <input type="text" id="MSearchField" value="Search" accesskey="S"
30              onfocus="searchBox.OnSearchFieldFocus(true)" 
31              onblur="searchBox.OnSearchFieldFocus(false)" 
32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
34         </div>
35       </li>
36     </ul>
37   </div>
38   <div class="tabs">
39     <ul>
40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
43     </ul>
44   </div>
45 </div>
46 <div class="contents">
47 <h1>UrpoConnectionSettings Class Reference</h1><!-- doxytag: class="UrpoConnectionSettings" --><!-- doxytag: inherits="UrpoConnection" -->
48 <p>Connection information, support storing settings.  
49 <a href="#_details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="urpoconnectionsettings_8h_source.html">urpoconnectionsettings.h</a>&gt;</code></p>
52 <div class="dynheader">
53 Inheritance diagram for UrpoConnectionSettings:</div>
54 <div class="dynsection">
55  <div class="center">
56   <img src="class_urpo_connection_settings.png" usemap="#UrpoConnectionSettings_map" alt=""/>
57   <map id="UrpoConnectionSettings_map" name="UrpoConnectionSettings_map">
58 <area href="class_urpo_connection.html" alt="UrpoConnection" shape="rect" coords="0,0,147,24"/>
59 </map>
60  </div>
61 </div>
62
63 <p><a href="class_urpo_connection_settings-members.html">List of all members.</a></p>
64 <table border="0" cellpadding="0" cellspacing="0">
65 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
66 <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>
67 <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>
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host name or ip address.  <a href="#a2b24ed1467e465c776b8fc9fea398ba3"></a><br/></td></tr>
69 <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>
70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identity file.  <a href="#af929c71f228d34ef86a0f940aa7910ae"></a><br/></td></tr>
71 <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>
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Userid in server.  <a href="#a628e651c01d58bd283308fab9aba98be"></a><br/></td></tr>
73 <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)" -->
74 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setHost</b> (const QString &amp;host)</td></tr>
75 <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)" -->
76 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setIdentity</b> (const QString &amp;password)</td></tr>
77 <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)" -->
78 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setUserid</b> (const QString &amp;userid)</td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e61e966401d23fd3be80438e1d36dc"></a><!-- doxytag: member="UrpoConnectionSettings::store" ref="a72e61e966401d23fd3be80438e1d36dc" args="() const " -->
80 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a72e61e966401d23fd3be80438e1d36dc">store</a> () const </td></tr>
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Store settings via QSettings. <br/></td></tr>
82 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26ee65650e3dac5508ab99ee2a591cb2"></a><!-- doxytag: member="UrpoConnectionSettings::load" ref="a26ee65650e3dac5508ab99ee2a591cb2" args="()" -->
83 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection_settings.html#a26ee65650e3dac5508ab99ee2a591cb2">load</a> ()</td></tr>
84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load settings via QSettings. <br/></td></tr>
85 </table>
86 <hr/><a name="_details"></a><h2>Detailed Description</h2>
87 <p>Connection information, support storing settings. </p>
88 <p>Setting are stored/loaded using QSettings</p>
89 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
90 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
91 <dl class="version"><dt><b>Version:</b></dt><dd>1 </dd></dl>
92
93 <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>
94 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
95 <a class="anchor" id="a4d6b405e37d84d891d439087eaa196c8"></a><!-- doxytag: member="UrpoConnectionSettings::UrpoConnectionSettings" ref="a4d6b405e37d84d891d439087eaa196c8" args="(const QString organization=QString(), const QString application=QString())" -->
96 <div class="memitem">
97 <div class="memproto">
98       <table class="memname">
99         <tr>
100           <td class="memname">UrpoConnectionSettings::UrpoConnectionSettings </td>
101           <td>(</td>
102           <td class="paramtype">const QString&nbsp;</td>
103           <td class="paramname"> <em>organization</em> = <code>QString()</code>, </td>
104         </tr>
105         <tr>
106           <td class="paramkey"></td>
107           <td></td>
108           <td class="paramtype">const QString&nbsp;</td>
109           <td class="paramname"> <em>application</em> = <code>QString()</code></td><td>&nbsp;</td>
110         </tr>
111         <tr>
112           <td></td>
113           <td>)</td>
114           <td></td><td></td><td></td>
115         </tr>
116       </table>
117 </div>
118 <div class="memdoc">
119 <dl><dt><b>Parameters:</b></dt><dd>
120   <table border="0" cellspacing="2" cellpadding="0">
121     <tr><td valign="top"></td><td valign="top"><em>organization</em>&nbsp;</td><td>Organization key for storing settings </td></tr>
122     <tr><td valign="top"></td><td valign="top"><em>application</em>&nbsp;</td><td>Application key for storing settings </td></tr>
123   </table>
124   </dd>
125 </dl>
126
127 <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>
128
129 </div>
130 </div>
131 <hr/><h2>Member Function Documentation</h2>
132 <a class="anchor" id="a2b24ed1467e465c776b8fc9fea398ba3"></a><!-- doxytag: member="UrpoConnectionSettings::getHost" ref="a2b24ed1467e465c776b8fc9fea398ba3" args="() const " -->
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname">QString UrpoConnectionSettings::getHost </td>
138           <td>(</td>
139           <td class="paramname"></td>
140           <td>&nbsp;)&nbsp;</td>
141           <td> const<code> [virtual]</code></td>
142         </tr>
143       </table>
144 </div>
145 <div class="memdoc">
146
147 <p>Host name or ip address. </p>
148 <dl class="return"><dt><b>Returns:</b></dt><dd>Server host name of ip address </dd></dl>
149
150 <p>Implements <a class="el" href="class_urpo_connection.html#acfaef63e321ad056ef6da06772967c3b">UrpoConnection</a>.</p>
151
152 <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>
153
154 </div>
155 </div>
156 <a class="anchor" id="af929c71f228d34ef86a0f940aa7910ae"></a><!-- doxytag: member="UrpoConnectionSettings::getIdentity" ref="af929c71f228d34ef86a0f940aa7910ae" args="() const " -->
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname">QString UrpoConnectionSettings::getIdentity </td>
162           <td>(</td>
163           <td class="paramname"></td>
164           <td>&nbsp;)&nbsp;</td>
165           <td> const<code> [virtual]</code></td>
166         </tr>
167       </table>
168 </div>
169 <div class="memdoc">
170
171 <p>Identity file. </p>
172 <p>ssh identity file (private key)</p>
173 <dl class="return"><dt><b>Returns:</b></dt><dd>ssh identity file path </dd></dl>
174
175 <p>Implements <a class="el" href="class_urpo_connection.html#ade5d637438a69724385e268fe32d989c">UrpoConnection</a>.</p>
176
177 <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>
178
179 </div>
180 </div>
181 <a class="anchor" id="a628e651c01d58bd283308fab9aba98be"></a><!-- doxytag: member="UrpoConnectionSettings::getUserid" ref="a628e651c01d58bd283308fab9aba98be" args="() const " -->
182 <div class="memitem">
183 <div class="memproto">
184       <table class="memname">
185         <tr>
186           <td class="memname">QString UrpoConnectionSettings::getUserid </td>
187           <td>(</td>
188           <td class="paramname"></td>
189           <td>&nbsp;)&nbsp;</td>
190           <td> const<code> [virtual]</code></td>
191         </tr>
192       </table>
193 </div>
194 <div class="memdoc">
195
196 <p>Userid in server. </p>
197 <dl class="return"><dt><b>Returns:</b></dt><dd>userid in server </dd></dl>
198
199 <p>Implements <a class="el" href="class_urpo_connection.html#aba99d8ff49fffbca8346d54adf244c84">UrpoConnection</a>.</p>
200
201 <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>
202
203 </div>
204 </div>
205 <hr/>The documentation for this class was generated from the following files:<ul>
206 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoconnectionsettings_8h_source.html">urpoconnectionsettings.h</a></li>
207 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoconnectionsettings_8cpp_source.html">urpoconnectionsettings.cpp</a></li>
208 </ul>
209 </div>
210 <!--- window showing the filter options -->
211 <div id="MSearchSelectWindow"
212      onmouseover="return searchBox.OnSearchSelectShow()"
213      onmouseout="return searchBox.OnSearchSelectHide()"
214      onkeydown="return searchBox.OnSearchSelectKey(event)">
215 <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>
216
217 <!-- iframe showing the search results (closed by default) -->
218 <div id="MSearchResultsWindow">
219 <iframe src="" frameborder="0" 
220         name="MSearchResults" id="MSearchResults">
221 </iframe>
222 </div>
223
224 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
225 <a href="http://www.doxygen.org/index.html">
226 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
227 </body>
228 </html>