src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CooperationPage.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CooperationPage.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,167 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.ConfigurationPages.CooperationPage</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Preferences.ConfigurationPages.CooperationPage</h1>
+
+<p>
+Module implementing the Cooperation configuration page.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#CooperationPage">CooperationPage</a></td>
+<td>Class implementing the Cooperation configuration page.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#create">create</a></td>
+<td>Module function to create the configuration page.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="CooperationPage" ID="CooperationPage"></a>
+<h2>CooperationPage</h2>
+
+<p>
+    Class implementing the Cooperation configuration page.
+</p>
+<h3>Derived from</h3>
+ConfigurationPageBase, Ui_CooperationPage
+<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="#CooperationPage.__init__">CooperationPage</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#CooperationPage.on_addBannedUserButton_clicked">on_addBannedUserButton_clicked</a></td>
+<td>Private slot to add a user to the list of banned users.</td>
+</tr>
+<tr>
+<td><a href="#CooperationPage.on_bannedUserEdit_textChanged">on_bannedUserEdit_textChanged</a></td>
+<td>Private slot to handle the user entering a banned user.</td>
+</tr>
+<tr>
+<td><a href="#CooperationPage.on_bannedUsersList_itemSelectionChanged">on_bannedUsersList_itemSelectionChanged</a></td>
+<td>Private slot to react on changes of selected banned users.</td>
+</tr>
+<tr>
+<td><a href="#CooperationPage.on_deleteBannedUsersButton_clicked">on_deleteBannedUsersButton_clicked</a></td>
+<td>Private slot to remove the selected users from the list of banned users.</td>
+</tr>
+<tr>
+<td><a href="#CooperationPage.save">save</a></td>
+<td>Public slot to save the Cooperation configuration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="CooperationPage.__init__" ID="CooperationPage.__init__"></a>
+<h4>CooperationPage (Constructor)</h4>
+<b>CooperationPage</b>(<i></i>)
+
+<p>
+        Constructor
+</p>
+<a NAME="CooperationPage.on_addBannedUserButton_clicked" ID="CooperationPage.on_addBannedUserButton_clicked"></a>
+<h4>CooperationPage.on_addBannedUserButton_clicked</h4>
+<b>on_addBannedUserButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to add a user to the list of banned users.
+</p>
+<a NAME="CooperationPage.on_bannedUserEdit_textChanged" ID="CooperationPage.on_bannedUserEdit_textChanged"></a>
+<h4>CooperationPage.on_bannedUserEdit_textChanged</h4>
+<b>on_bannedUserEdit_textChanged</b>(<i>txt</i>)
+
+<p>
+        Private slot to handle the user entering a banned user.
+</p>
+<dl>
+
+<dt><i>txt</i></dt>
+<dd>
+text entered by the user (string)
+</dd>
+</dl>
+<a NAME="CooperationPage.on_bannedUsersList_itemSelectionChanged" ID="CooperationPage.on_bannedUsersList_itemSelectionChanged"></a>
+<h4>CooperationPage.on_bannedUsersList_itemSelectionChanged</h4>
+<b>on_bannedUsersList_itemSelectionChanged</b>(<i></i>)
+
+<p>
+        Private slot to react on changes of selected banned users.
+</p>
+<a NAME="CooperationPage.on_deleteBannedUsersButton_clicked" ID="CooperationPage.on_deleteBannedUsersButton_clicked"></a>
+<h4>CooperationPage.on_deleteBannedUsersButton_clicked</h4>
+<b>on_deleteBannedUsersButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to remove the selected users from the list of
+        banned users.
+</p>
+<a NAME="CooperationPage.save" ID="CooperationPage.save"></a>
+<h4>CooperationPage.save</h4>
+<b>save</b>(<i></i>)
+
+<p>
+        Public slot to save the Cooperation configuration.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="create" ID="create"></a>
+<h2>create</h2>
+<b>create</b>(<i>dlg</i>)
+
+<p>
+    Module function to create the configuration page.
+</p>
+<dl>
+
+<dt><i>dlg</i></dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the instantiated page (ConfigurationPageBase)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial