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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.CooperationPage</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.Preferences.ConfigurationPages.CooperationPage</h1>
10
11 <p>
12 Module implementing the Cooperation configuration page.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#CooperationPage">CooperationPage</a></td>
25 <td>Class implementing the Cooperation configuration page.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31
32 <tr>
33 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td>
35 </tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="CooperationPage" ID="CooperationPage"></a>
40 <h2>CooperationPage</h2>
41
42 <p>
43 Class implementing the Cooperation configuration page.
44 </p>
45 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_CooperationPage
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#CooperationPage.__init__">CooperationPage</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#CooperationPage.on_addBannedUserButton_clicked">on_addBannedUserButton_clicked</a></td>
67 <td>Private slot to add a user to the list of banned users.</td>
68 </tr>
69 <tr>
70 <td><a href="#CooperationPage.on_bannedUserEdit_textChanged">on_bannedUserEdit_textChanged</a></td>
71 <td>Private slot to handle the user entering a banned user.</td>
72 </tr>
73 <tr>
74 <td><a href="#CooperationPage.on_bannedUsersList_itemSelectionChanged">on_bannedUsersList_itemSelectionChanged</a></td>
75 <td>Private slot to react on changes of selected banned users.</td>
76 </tr>
77 <tr>
78 <td><a href="#CooperationPage.on_deleteBannedUsersButton_clicked">on_deleteBannedUsersButton_clicked</a></td>
79 <td>Private slot to remove the selected users from the list of banned users.</td>
80 </tr>
81 <tr>
82 <td><a href="#CooperationPage.save">save</a></td>
83 <td>Public slot to save the Cooperation configuration.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="CooperationPage.__init__" ID="CooperationPage.__init__"></a>
93 <h4>CooperationPage (Constructor)</h4>
94 <b>CooperationPage</b>(<i></i>)
95
96 <p>
97 Constructor
98 </p>
99 <a NAME="CooperationPage.on_addBannedUserButton_clicked" ID="CooperationPage.on_addBannedUserButton_clicked"></a>
100 <h4>CooperationPage.on_addBannedUserButton_clicked</h4>
101 <b>on_addBannedUserButton_clicked</b>(<i></i>)
102
103 <p>
104 Private slot to add a user to the list of banned users.
105 </p>
106 <a NAME="CooperationPage.on_bannedUserEdit_textChanged" ID="CooperationPage.on_bannedUserEdit_textChanged"></a>
107 <h4>CooperationPage.on_bannedUserEdit_textChanged</h4>
108 <b>on_bannedUserEdit_textChanged</b>(<i>txt</i>)
109
110 <p>
111 Private slot to handle the user entering a banned user.
112 </p>
113 <dl>
114
115 <dt><i>txt</i></dt>
116 <dd>
117 text entered by the user (string)
118 </dd>
119 </dl>
120 <a NAME="CooperationPage.on_bannedUsersList_itemSelectionChanged" ID="CooperationPage.on_bannedUsersList_itemSelectionChanged"></a>
121 <h4>CooperationPage.on_bannedUsersList_itemSelectionChanged</h4>
122 <b>on_bannedUsersList_itemSelectionChanged</b>(<i></i>)
123
124 <p>
125 Private slot to react on changes of selected banned users.
126 </p>
127 <a NAME="CooperationPage.on_deleteBannedUsersButton_clicked" ID="CooperationPage.on_deleteBannedUsersButton_clicked"></a>
128 <h4>CooperationPage.on_deleteBannedUsersButton_clicked</h4>
129 <b>on_deleteBannedUsersButton_clicked</b>(<i></i>)
130
131 <p>
132 Private slot to remove the selected users from the list of
133 banned users.
134 </p>
135 <a NAME="CooperationPage.save" ID="CooperationPage.save"></a>
136 <h4>CooperationPage.save</h4>
137 <b>save</b>(<i></i>)
138
139 <p>
140 Public slot to save the Cooperation configuration.
141 </p>
142 <div align="right"><a href="#top">Up</a></div>
143 <hr />
144 <hr />
145 <a NAME="create" ID="create"></a>
146 <h2>create</h2>
147 <b>create</b>(<i>dlg</i>)
148
149 <p>
150 Module function to create the configuration page.
151 </p>
152 <dl>
153
154 <dt><i>dlg</i></dt>
155 <dd>
156 reference to the configuration dialog
157 </dd>
158 </dl>
159 <dl>
160 <dt>Return:</dt>
161 <dd>
162 reference to the instantiated page (ConfigurationPageBase)
163 </dd>
164 </dl>
165 <div align="right"><a href="#top">Up</a></div>
166 <hr />
167 </body></html>

eric ide

mercurial