src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiConnectionDialog.html

branch
mpy_network
changeset 9800
25f388536caf
child 9871
4a302b8c4d28
equal deleted inserted replaced
9799:a79430a8811d 9800:25f388536caf
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.MicroPython.WifiDialogs.WifiConnectionDialog</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.MicroPython.WifiDialogs.WifiConnectionDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the parameters needed to connect to a WiFi
13 network.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#WifiConnectionDialog">WifiConnectionDialog</a></td>
26 <td>Class implementing a dialog to enter the parameters needed to connect to a WiFi network.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="WifiConnectionDialog" ID="WifiConnectionDialog"></a>
37 <h2>WifiConnectionDialog</h2>
38
39 <p>
40 Class implementing a dialog to enter the parameters needed to connect to a WiFi
41 network.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_WifiConnectionDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#WifiConnectionDialog.__init__">WifiConnectionDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#WifiConnectionDialog.getConnectionParameters">getConnectionParameters</a></td>
65 <td>Public method to get the entered connection parameters.</td>
66 </tr>
67 <tr>
68 <td><a href="#WifiConnectionDialog.on_showPasswordButton_clicked">on_showPasswordButton_clicked</a></td>
69 <td>Private slot to show or hide the password.</td>
70 </tr>
71 <tr>
72 <td><a href="#WifiConnectionDialog.on_ssidEdit_textChanged">on_ssidEdit_textChanged</a></td>
73 <td>Private slot handling a change of the SSID.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81
82 <a NAME="WifiConnectionDialog.__init__" ID="WifiConnectionDialog.__init__"></a>
83 <h4>WifiConnectionDialog (Constructor)</h4>
84 <b>WifiConnectionDialog</b>(<i>parent=None</i>)
85
86 <p>
87 Constructor
88 </p>
89 <dl>
90
91 <dt><i>parent</i> (QWidget (optional))</dt>
92 <dd>
93 reference to the parent widget (defaults to None)
94 </dd>
95 </dl>
96 <a NAME="WifiConnectionDialog.getConnectionParameters" ID="WifiConnectionDialog.getConnectionParameters"></a>
97 <h4>WifiConnectionDialog.getConnectionParameters</h4>
98 <b>getConnectionParameters</b>(<i></i>)
99
100 <p>
101 Public method to get the entered connection parameters.
102 </p>
103 <dl>
104 <dt>Return:</dt>
105 <dd>
106 tuple containing the SSID, password and a flag indicating, if the
107 parameters shall be saved to the preferences
108 </dd>
109 </dl>
110 <dl>
111 <dt>Return Type:</dt>
112 <dd>
113 tuple of (str, str, bool)
114 </dd>
115 </dl>
116 <a NAME="WifiConnectionDialog.on_showPasswordButton_clicked" ID="WifiConnectionDialog.on_showPasswordButton_clicked"></a>
117 <h4>WifiConnectionDialog.on_showPasswordButton_clicked</h4>
118 <b>on_showPasswordButton_clicked</b>(<i>checked</i>)
119
120 <p>
121 Private slot to show or hide the password.
122 </p>
123 <dl>
124
125 <dt><i>checked</i> (bool)</dt>
126 <dd>
127 state of the button
128 </dd>
129 </dl>
130 <a NAME="WifiConnectionDialog.on_ssidEdit_textChanged" ID="WifiConnectionDialog.on_ssidEdit_textChanged"></a>
131 <h4>WifiConnectionDialog.on_ssidEdit_textChanged</h4>
132 <b>on_ssidEdit_textChanged</b>(<i>ssid</i>)
133
134 <p>
135 Private slot handling a change of the SSID.
136 </p>
137 <dl>
138
139 <dt><i>ssid</i> (str)</dt>
140 <dd>
141 entered SSID
142 </dd>
143 </dl>
144 <div align="right"><a href="#top">Up</a></div>
145 <hr />
146 </body></html>

eric ide

mercurial