src/eric7/Documentation/Source/eric7.EricWidgets.EricAuthenticationDialog.html

branch
eric7
changeset 10925
22c3928a1ab5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricAuthenticationDialog.html	Wed Sep 25 14:07:40 2024 +0200
@@ -0,0 +1,166 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricAuthenticationDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricAuthenticationDialog</h1>
+<p>
+Module implementing the authentication dialog for the help browser.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#EricAuthenticationDialog">EricAuthenticationDialog</a></td>
+<td>Class implementing the authentication dialog for the help browser.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="EricAuthenticationDialog" ID="EricAuthenticationDialog"></a>
+<h2>EricAuthenticationDialog</h2>
+<p>
+    Class implementing the authentication dialog for the help browser.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_EricAuthenticationDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#EricAuthenticationDialog.__init__">EricAuthenticationDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricAuthenticationDialog.getData">getData</a></td>
+<td>Public method to retrieve the login data.</td>
+</tr>
+<tr>
+<td><a href="#EricAuthenticationDialog.setData">setData</a></td>
+<td>Public method to set the login data.</td>
+</tr>
+<tr>
+<td><a href="#EricAuthenticationDialog.shallSave">shallSave</a></td>
+<td>Public method to check, if the login data shall be saved.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="EricAuthenticationDialog.__init__" ID="EricAuthenticationDialog.__init__"></a>
+<h4>EricAuthenticationDialog (Constructor)</h4>
+<b>EricAuthenticationDialog</b>(<i>info, username, showSave=False, saveIt=False, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>info</i> (str)</dt>
+<dd>
+information to be shown
+</dd>
+<dt><i>username</i> (str)</dt>
+<dd>
+username as supplied by subversion
+</dd>
+<dt><i>showSave</i> (bool)</dt>
+<dd>
+flag to indicate to show the save checkbox
+</dd>
+<dt><i>saveIt</i> (bool)</dt>
+<dd>
+flag indicating the value for the save checkbox
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="EricAuthenticationDialog.getData" ID="EricAuthenticationDialog.getData"></a>
+<h4>EricAuthenticationDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to retrieve the login data.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the user name and password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<a NAME="EricAuthenticationDialog.setData" ID="EricAuthenticationDialog.setData"></a>
+<h4>EricAuthenticationDialog.setData</h4>
+<b>setData</b>(<i>username, password</i>)
+<p>
+        Public method to set the login data.
+</p>
+
+<dl>
+
+<dt><i>username</i> (str)</dt>
+<dd>
+username
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password
+</dd>
+</dl>
+<a NAME="EricAuthenticationDialog.shallSave" ID="EricAuthenticationDialog.shallSave"></a>
+<h4>EricAuthenticationDialog.shallSave</h4>
+<b>shallSave</b>(<i></i>)
+<p>
+        Public method to check, if the login data shall be saved.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating that the login data shall be saved
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial