Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerConnectionDialog.html
src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerConnectionDialog.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- child 11033
- 6b197c3389f7
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServerInterface.EricServerConnectionDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.RemoteServerInterface.EricServerConnectionDialog</h1> | |
| 10 <p> | |
| 11 Module implementing a dialog to enter the parameters for a connection to an eric-ide | |
| 12 server. | |
| 13 </p> | |
| 14 | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 | |
| 20 <h3>Classes</h3> | |
| 21 <table> | |
| 22 <tr> | |
| 23 <td><a href="#EricServerConnectionDialog">EricServerConnectionDialog</a></td> | |
| 24 <td>Class implementing a dialog to enter the parameters for a connection to an eric-ide server.</td> | |
| 25 </tr> | |
| 26 </table> | |
| 27 | |
| 28 <h3>Functions</h3> | |
| 29 <table> | |
| 30 <tr><td>None</td></tr> | |
| 31 </table> | |
| 32 | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="EricServerConnectionDialog" ID="EricServerConnectionDialog"></a> | |
| 36 <h2>EricServerConnectionDialog</h2> | |
| 37 <p> | |
| 38 Class implementing a dialog to enter the parameters for a connection to an eric-ide | |
| 39 server. | |
| 40 </p> | |
| 41 | |
| 42 <h3>Derived from</h3> | |
| 43 QDialog, Ui_EricServerConnectionDialog | |
| 44 <h3>Class Attributes</h3> | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 | |
| 49 <h3>Class Methods</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#EricServerConnectionDialog.__init__">EricServerConnectionDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#EricServerConnectionDialog.__updateOK">__updateOK</a></td> | |
| 62 <td>Private slot to update the enabled state of the OK button.</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#EricServerConnectionDialog.getData">getData</a></td> | |
| 66 <td>Public method to get the entered data.</td> | |
| 67 </tr> | |
| 68 <tr> | |
| 69 <td><a href="#EricServerConnectionDialog.getProfileData">getProfileData</a></td> | |
| 70 <td>Public method to get the entered data for connection profile mode.</td> | |
| 71 </tr> | |
| 72 <tr> | |
| 73 <td><a href="#EricServerConnectionDialog.setProfileData">setProfileData</a></td> | |
| 74 <td>Public method to set the connection profile data to be edited.</td> | |
| 75 </tr> | |
| 76 </table> | |
| 77 | |
| 78 <h3>Static Methods</h3> | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 | |
| 83 | |
| 84 <a NAME="EricServerConnectionDialog.__init__" ID="EricServerConnectionDialog.__init__"></a> | |
| 85 <h4>EricServerConnectionDialog (Constructor)</h4> | |
| 86 <b>EricServerConnectionDialog</b>(<i>profileNames=None, parent=None</i>) | |
| 87 <p> | |
| 88 Constructor | |
| 89 </p> | |
| 90 | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>profileNames</i> (list of str (optional))</dt> | |
| 94 <dd> | |
| 95 list of defined connection profile names (defaults to None) | |
| 96 </dd> | |
| 97 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 98 <dd> | |
| 99 reference to the parent widget (defaults to None) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <a NAME="EricServerConnectionDialog.__updateOK" ID="EricServerConnectionDialog.__updateOK"></a> | |
| 103 <h4>EricServerConnectionDialog.__updateOK</h4> | |
| 104 <b>__updateOK</b>(<i></i>) | |
| 105 <p> | |
| 106 Private slot to update the enabled state of the OK button. | |
| 107 </p> | |
| 108 | |
| 109 <a NAME="EricServerConnectionDialog.getData" ID="EricServerConnectionDialog.getData"></a> | |
| 110 <h4>EricServerConnectionDialog.getData</h4> | |
| 111 <b>getData</b>(<i></i>) | |
| 112 <p> | |
| 113 Public method to get the entered data. | |
| 114 </p> | |
| 115 | |
| 116 <dl> | |
| 117 <dt>Return:</dt> | |
| 118 <dd> | |
| 119 tuple containing the entered host name or IP address, the port number | |
| 120 and the timeout (in seconds) | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 tuple of (str, int, int) | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <a NAME="EricServerConnectionDialog.getProfileData" ID="EricServerConnectionDialog.getProfileData"></a> | |
| 130 <h4>EricServerConnectionDialog.getProfileData</h4> | |
| 131 <b>getProfileData</b>(<i></i>) | |
| 132 <p> | |
| 133 Public method to get the entered data for connection profile mode. | |
| 134 </p> | |
| 135 | |
| 136 <dl> | |
| 137 <dt>Return:</dt> | |
| 138 <dd> | |
| 139 tuple containing the profile name, host name or IP address, | |
| 140 the port number and the timeout (in seconds) | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 tuple of (str, str, int, int) | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="EricServerConnectionDialog.setProfileData" ID="EricServerConnectionDialog.setProfileData"></a> | |
| 150 <h4>EricServerConnectionDialog.setProfileData</h4> | |
| 151 <b>setProfileData</b>(<i>name, hostname, port, timeout</i>) | |
| 152 <p> | |
| 153 Public method to set the connection profile data to be edited. | |
| 154 </p> | |
| 155 | |
| 156 <dl> | |
| 157 | |
| 158 <dt><i>name</i> (str)</dt> | |
| 159 <dd> | |
| 160 profile name | |
| 161 </dd> | |
| 162 <dt><i>hostname</i> (str)</dt> | |
| 163 <dd> | |
| 164 host name or IP address | |
| 165 </dd> | |
| 166 <dt><i>port</i> (int)</dt> | |
| 167 <dd> | |
| 168 port number | |
| 169 </dd> | |
| 170 <dt><i>timeout</i> (int)</dt> | |
| 171 <dd> | |
| 172 timeout value in seconds | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <div align="right"><a href="#top">Up</a></div> | |
| 176 <hr /> | |
| 177 </body></html> |
