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