Documentation/Source/eric5.UI.AuthenticationDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.UI.AuthenticationDialog</h1> 23 <h1>eric5.UI.AuthenticationDialog</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;. 25 Module implementing the authentication dialog for the help browser.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td> 34 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;.</td> 35 <td>Class implementing the authentication dialog for the help browser.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a> 43 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a>
44 <h2>AuthenticationDialog</h2> 44 <h2>AuthenticationDialog</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;. 46 Class implementing the authentication dialog for the help browser.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QDialog, Ui_AuthenticationDialog 49 QDialog, Ui_AuthenticationDialog
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td> 57 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#AuthenticationDialog.getData">getData</a></td> 60 <td><a href="#AuthenticationDialog.getData">getData</a></td>
61 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.</td> 61 <td>Public method to retrieve the login data.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#AuthenticationDialog.setData">setData</a></td> 63 <td><a href="#AuthenticationDialog.setData">setData</a></td>
64 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.</td> 64 <td>Public method to set the login data.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td> 66 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td>
67 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100;.</td> 67 <td>Public method to check, if the login data shall be saved.</td>
68 </tr> 68 </tr>
69 </table> 69 </table>
70 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a> 70 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a>
71 <h4>AuthenticationDialog (Constructor)</h4> 71 <h4>AuthenticationDialog (Constructor)</h4>
72 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>) 72 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>)
73 <p> 73 <p>
74 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 74 Constructor
75 </p><dl> 75 </p><dl>
76 <dt><i>info</i></dt> 76 <dt><i>info</i></dt>
77 <dd> 77 <dd>
78 &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 78 information to be shown (string)
79 </dd><dt><i>username</i></dt> 79 </dd><dt><i>username</i></dt>
80 <dd> 80 <dd>
81 &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#115; &#115;&#117;&#112;&#112;&#108;&#105;&#101;&#100; &#98;y &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 81 username as supplied by subversion (string)
82 </dd><dt><i>showSave</i></dt> 82 </dd><dt><i>showSave</i></dt>
83 <dd> 83 <dd>
84 &#102;&#108;&#97;&#103; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#115;&#97;v&#101; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 84 flag to indicate to show the save checkbox (boolean)
85 </dd><dt><i>saveIt</i></dt> 85 </dd><dt><i>saveIt</i></dt>
86 <dd> 86 <dd>
87 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#97;v&#101; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 87 flag indicating the value for the save checkbox (boolean)
88 </dd> 88 </dd>
89 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a> 89 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a>
90 <h4>AuthenticationDialog.getData</h4> 90 <h4>AuthenticationDialog.getData</h4>
91 <b>getData</b>(<i></i>) 91 <b>getData</b>(<i></i>)
92 <p> 92 <p>
93 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;. 93 Public method to retrieve the login data.
94 </p><dl> 94 </p><dl>
95 <dt>Returns:</dt> 95 <dt>Returns:</dt>
96 <dd> 96 <dd>
97 &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103; v&#97;&#108;&#117;&#101;&#115; (&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101;, &#112;&#97;&#115;&#115;w&#111;&#114;&#100;) 97 tuple of two string values (username, password)
98 </dd> 98 </dd>
99 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a> 99 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a>
100 <h4>AuthenticationDialog.setData</h4> 100 <h4>AuthenticationDialog.setData</h4>
101 <b>setData</b>(<i>username, password</i>) 101 <b>setData</b>(<i>username, password</i>)
102 <p> 102 <p>
103 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;. 103 Public method to set the login data.
104 </p><dl> 104 </p><dl>
105 <dt><i>username</i></dt> 105 <dt><i>username</i></dt>
106 <dd> 106 <dd>
107 &#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 107 username (string)
108 </dd><dt><i>password</i></dt> 108 </dd><dt><i>password</i></dt>
109 <dd> 109 <dd>
110 &#112;&#97;&#115;&#115;w&#111;&#114;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 110 password (string)
111 </dd> 111 </dd>
112 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a> 112 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a>
113 <h4>AuthenticationDialog.shallSave</h4> 113 <h4>AuthenticationDialog.shallSave</h4>
114 <b>shallSave</b>(<i></i>) 114 <b>shallSave</b>(<i></i>)
115 <p> 115 <p>
116 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100;. 116 Public method to check, if the login data shall be saved.
117 </p><dl> 117 </p><dl>
118 <dt>Returns:</dt> 118 <dt>Returns:</dt>
119 <dd> 119 <dd>
120 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#97;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 120 flag indicating that the login data shall be saved (boolean)
121 </dd> 121 </dd>
122 </dl> 122 </dl>
123 <div align="right"><a href="#top">Up</a></div> 123 <div align="right"><a href="#top">Up</a></div>
124 <hr /> 124 <hr />
125 </body></html> 125 </body></html>

eric ide

mercurial