Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog.html

eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog.html

changeset 7232
0b840f7ed593
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
7231:0dcb92a9687d 7232:0b840f7ed593
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> 60 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td>
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#QtHelpDocumentationDialog.__hasChangedFilters">__hasChangedFilters</a></td>
64 <td>Private method to determine, if there are filter changes.</td>
65 </tr><tr>
66 <td><a href="#QtHelpDocumentationDialog.__initDocumentsTab">__initDocumentsTab</a></td>
67 <td>Private method to initialize the documents tab.</td>
68 </tr><tr>
69 <td><a href="#QtHelpDocumentationDialog.__initFiltersTab">__initFiltersTab</a></td>
70 <td>Private method to initialize the filters tab.</td>
71 </tr><tr>
63 <td><a href="#QtHelpDocumentationDialog.__registerDocumentations">__registerDocumentations</a></td> 72 <td><a href="#QtHelpDocumentationDialog.__registerDocumentations">__registerDocumentations</a></td>
64 <td>Private method to register a given list of documentations.</td> 73 <td>Private method to register a given list of documentations.</td>
65 </tr><tr> 74 </tr><tr>
75 <td><a href="#QtHelpDocumentationDialog.__removeAttributes">__removeAttributes</a></td>
76 <td>Private method to remove attributes from the Qt Help database.</td>
77 </tr><tr>
66 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> 78 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td>
67 <td>Public method to get the list of tabs to close.</td> 79 <td>Public method to get the list of tabs to close.</td>
68 </tr><tr> 80 </tr><tr>
69 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> 81 <td><a href="#QtHelpDocumentationDialog.hasDocumentationChanges">hasDocumentationChanges</a></td>
70 <td>Public slot to test the dialog for changes.</td> 82 <td>Public slot to test the dialog for changes of configured QtHelp documents.</td>
71 </tr><tr> 83 </tr><tr>
72 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> 84 <td><a href="#QtHelpDocumentationDialog.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td>
73 <td>Private slot to add QtHelp documents to the help database.</td> 85 <td>Private slot to add QtHelp documents to the help database.</td>
86 </tr><tr>
87 <td><a href="#QtHelpDocumentationDialog.on_addFilterButton_clicked">on_addFilterButton_clicked</a></td>
88 <td>Private slot to add a new filter.</td>
74 </tr><tr> 89 </tr><tr>
75 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td> 90 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td>
76 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td> 91 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td>
77 </tr><tr> 92 </tr><tr>
93 <td><a href="#QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked">on_applyFilterChangesButton_clicked</a></td>
94 <td>Private slot to apply the filter changes.</td>
95 </tr><tr>
96 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemChanged">on_attributesList_itemChanged</a></td>
97 <td>Private slot to handle a change of an attribute.</td>
98 </tr><tr>
99 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged">on_attributesList_itemSelectionChanged</a></td>
100 <td>Private slot handling the selection of attributes.</td>
101 </tr><tr>
78 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> 102 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td>
79 <td>Private slot handling a change of the documents selection.</td> 103 <td>Private slot handling a change of the documents selection.</td>
80 </tr><tr> 104 </tr><tr>
105 <td><a href="#QtHelpDocumentationDialog.on_filtersList_currentItemChanged">on_filtersList_currentItemChanged</a></td>
106 <td>Private slot to update the attributes depending on the current filter.</td>
107 </tr><tr>
108 <td><a href="#QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged">on_filtersList_itemSelectionChanged</a></td>
109 <td>Private slot handling a change of selected filters.</td>
110 </tr><tr>
81 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td> 111 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td>
82 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td> 112 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td>
83 </tr><tr> 113 </tr><tr>
84 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> 114 <td><a href="#QtHelpDocumentationDialog.on_removeAttributesButton_clicked">on_removeAttributesButton_clicked</a></td>
115 <td>Private slot to remove the selected filter attributes.</td>
116 </tr><tr>
117 <td><a href="#QtHelpDocumentationDialog.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td>
85 <td>Private slot to remove a document from the help database.</td> 118 <td>Private slot to remove a document from the help database.</td>
119 </tr><tr>
120 <td><a href="#QtHelpDocumentationDialog.on_removeFiltersButton_clicked">on_removeFiltersButton_clicked</a></td>
121 <td>Private slot to remove the selected filters.</td>
122 </tr><tr>
123 <td><a href="#QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked">on_resetFilterChangesButton_clicked</a></td>
124 <td>Private slot to forget the filter changes and reset the tab.</td>
125 </tr><tr>
126 <td><a href="#QtHelpDocumentationDialog.on_tabWidget_currentChanged">on_tabWidget_currentChanged</a></td>
127 <td>Private slot handling a change of the current tab.</td>
128 </tr><tr>
129 <td><a href="#QtHelpDocumentationDialog.on_unusedAttributesButton_clicked">on_unusedAttributesButton_clicked</a></td>
130 <td>Private slot to select all unused attributes.</td>
86 </tr> 131 </tr>
87 </table> 132 </table>
88 <h3>Static Methods</h3> 133 <h3>Static Methods</h3>
89 <table> 134 <table>
90 <tr><td>None</td></tr> 135 <tr><td>None</td></tr>
100 reference to the help engine (QHelpEngine) 145 reference to the help engine (QHelpEngine)
101 </dd><dt><i>parent</i></dt> 146 </dd><dt><i>parent</i></dt>
102 <dd> 147 <dd>
103 reference to the parent widget (QWidget) 148 reference to the parent widget (QWidget)
104 </dd> 149 </dd>
105 </dl><a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a> 150 </dl><a NAME="QtHelpDocumentationDialog.__hasChangedFilters" ID="QtHelpDocumentationDialog.__hasChangedFilters"></a>
151 <h4>QtHelpDocumentationDialog.__hasChangedFilters</h4>
152 <b>__hasChangedFilters</b>(<i></i>)
153 <p>
154 Private method to determine, if there are filter changes.
155 </p><dl>
156 <dt>Returns:</dt>
157 <dd>
158 flag indicating the presence of filter changes
159 </dd>
160 </dl><dl>
161 <dt>Return Type:</dt>
162 <dd>
163 bool
164 </dd>
165 </dl><a NAME="QtHelpDocumentationDialog.__initDocumentsTab" ID="QtHelpDocumentationDialog.__initDocumentsTab"></a>
166 <h4>QtHelpDocumentationDialog.__initDocumentsTab</h4>
167 <b>__initDocumentsTab</b>(<i></i>)
168 <p>
169 Private method to initialize the documents tab.
170 </p><a NAME="QtHelpDocumentationDialog.__initFiltersTab" ID="QtHelpDocumentationDialog.__initFiltersTab"></a>
171 <h4>QtHelpDocumentationDialog.__initFiltersTab</h4>
172 <b>__initFiltersTab</b>(<i></i>)
173 <p>
174 Private method to initialize the filters tab.
175 </p><a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a>
106 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4> 176 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4>
107 <b>__registerDocumentations</b>(<i>fileNames</i>) 177 <b>__registerDocumentations</b>(<i>fileNames</i>)
108 <p> 178 <p>
109 Private method to register a given list of documentations. 179 Private method to register a given list of documentations.
110 </p><dl> 180 </p><dl>
111 <dt><i>fileNames</i> (list of str)</dt> 181 <dt><i>fileNames</i> (list of str)</dt>
112 <dd> 182 <dd>
113 list of documentation files to be registered 183 list of documentation files to be registered
114 </dd> 184 </dd>
115 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> 185 </dl><a NAME="QtHelpDocumentationDialog.__removeAttributes" ID="QtHelpDocumentationDialog.__removeAttributes"></a>
186 <h4>QtHelpDocumentationDialog.__removeAttributes</h4>
187 <b>__removeAttributes</b>(<i></i>)
188 <p>
189 Private method to remove attributes from the Qt Help database.
190 </p><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a>
116 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> 191 <h4>QtHelpDocumentationDialog.getTabsToClose</h4>
117 <b>getTabsToClose</b>(<i></i>) 192 <b>getTabsToClose</b>(<i></i>)
118 <p> 193 <p>
119 Public method to get the list of tabs to close. 194 Public method to get the list of tabs to close.
120 </p><dl> 195 </p><dl>
121 <dt>Returns:</dt> 196 <dt>Returns:</dt>
122 <dd> 197 <dd>
123 list of tab ids to be closed (list of integers) 198 list of tab ids to be closed
124 </dd> 199 </dd>
125 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> 200 </dl><dl>
126 <h4>QtHelpDocumentationDialog.hasChanges</h4> 201 <dt>Return Type:</dt>
127 <b>hasChanges</b>(<i></i>) 202 <dd>
128 <p> 203 list of int
129 Public slot to test the dialog for changes. 204 </dd>
205 </dl><a NAME="QtHelpDocumentationDialog.hasDocumentationChanges" ID="QtHelpDocumentationDialog.hasDocumentationChanges"></a>
206 <h4>QtHelpDocumentationDialog.hasDocumentationChanges</h4>
207 <b>hasDocumentationChanges</b>(<i></i>)
208 <p>
209 Public slot to test the dialog for changes of configured QtHelp
210 documents.
130 </p><dl> 211 </p><dl>
131 <dt>Returns:</dt> 212 <dt>Returns:</dt>
132 <dd> 213 <dd>
133 flag indicating presence of changes 214 flag indicating presence of changes
134 </dd> 215 </dd>
135 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> 216 </dl><dl>
136 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> 217 <dt>Return Type:</dt>
137 <b>on_addButton_clicked</b>(<i></i>) 218 <dd>
219 bool
220 </dd>
221 </dl><a NAME="QtHelpDocumentationDialog.on_addDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_addDocumentsButton_clicked"></a>
222 <h4>QtHelpDocumentationDialog.on_addDocumentsButton_clicked</h4>
223 <b>on_addDocumentsButton_clicked</b>(<i></i>)
138 <p> 224 <p>
139 Private slot to add QtHelp documents to the help database. 225 Private slot to add QtHelp documents to the help database.
226 </p><a NAME="QtHelpDocumentationDialog.on_addFilterButton_clicked" ID="QtHelpDocumentationDialog.on_addFilterButton_clicked"></a>
227 <h4>QtHelpDocumentationDialog.on_addFilterButton_clicked</h4>
228 <b>on_addFilterButton_clicked</b>(<i></i>)
229 <p>
230 Private slot to add a new filter.
140 </p><a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a> 231 </p><a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a>
141 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4> 232 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4>
142 <b>on_addPluginButton_clicked</b>(<i></i>) 233 <b>on_addPluginButton_clicked</b>(<i></i>)
143 <p> 234 <p>
144 Private slot to add QtHelp documents provided by plug-ins to 235 Private slot to add QtHelp documents provided by plug-ins to
145 the help database. 236 the help database.
237 </p><a NAME="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked"></a>
238 <h4>QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked</h4>
239 <b>on_applyFilterChangesButton_clicked</b>(<i></i>)
240 <p>
241 Private slot to apply the filter changes.
242 </p><a NAME="QtHelpDocumentationDialog.on_attributesList_itemChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemChanged"></a>
243 <h4>QtHelpDocumentationDialog.on_attributesList_itemChanged</h4>
244 <b>on_attributesList_itemChanged</b>(<i>item, column</i>)
245 <p>
246 Private slot to handle a change of an attribute.
247 </p><dl>
248 <dt><i>item</i></dt>
249 <dd>
250 reference to the changed item (QTreeWidgetItem)
251 </dd><dt><i>column</i></dt>
252 <dd>
253 column containing the change (integer)
254 </dd>
255 </dl><a NAME="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged"></a>
256 <h4>QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged</h4>
257 <b>on_attributesList_itemSelectionChanged</b>(<i></i>)
258 <p>
259 Private slot handling the selection of attributes.
146 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> 260 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a>
147 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> 261 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4>
148 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) 262 <b>on_documentsList_itemSelectionChanged</b>(<i></i>)
149 <p> 263 <p>
150 Private slot handling a change of the documents selection. 264 Private slot handling a change of the documents selection.
265 </p><a NAME="QtHelpDocumentationDialog.on_filtersList_currentItemChanged" ID="QtHelpDocumentationDialog.on_filtersList_currentItemChanged"></a>
266 <h4>QtHelpDocumentationDialog.on_filtersList_currentItemChanged</h4>
267 <b>on_filtersList_currentItemChanged</b>(<i>current, previous</i>)
268 <p>
269 Private slot to update the attributes depending on the current filter.
270 </p><dl>
271 <dt><i>current</i></dt>
272 <dd>
273 reference to the current item (QListWidgetitem)
274 </dd><dt><i>previous</i></dt>
275 <dd>
276 reference to the previous current item
277 (QListWidgetItem)
278 </dd>
279 </dl><a NAME="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged"></a>
280 <h4>QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged</h4>
281 <b>on_filtersList_itemSelectionChanged</b>(<i></i>)
282 <p>
283 Private slot handling a change of selected filters.
151 </p><a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a> 284 </p><a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a>
152 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4> 285 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4>
153 <b>on_managePluginButton_clicked</b>(<i></i>) 286 <b>on_managePluginButton_clicked</b>(<i></i>)
154 <p> 287 <p>
155 Private slot to manage the QtHelp documents provided by plug-ins. 288 Private slot to manage the QtHelp documents provided by plug-ins.
156 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> 289 </p><a NAME="QtHelpDocumentationDialog.on_removeAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_removeAttributesButton_clicked"></a>
157 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> 290 <h4>QtHelpDocumentationDialog.on_removeAttributesButton_clicked</h4>
158 <b>on_removeButton_clicked</b>(<i></i>) 291 <b>on_removeAttributesButton_clicked</b>(<i></i>)
292 <p>
293 Private slot to remove the selected filter attributes.
294 </p><a NAME="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked"></a>
295 <h4>QtHelpDocumentationDialog.on_removeDocumentsButton_clicked</h4>
296 <b>on_removeDocumentsButton_clicked</b>(<i></i>)
159 <p> 297 <p>
160 Private slot to remove a document from the help database. 298 Private slot to remove a document from the help database.
299 </p><a NAME="QtHelpDocumentationDialog.on_removeFiltersButton_clicked" ID="QtHelpDocumentationDialog.on_removeFiltersButton_clicked"></a>
300 <h4>QtHelpDocumentationDialog.on_removeFiltersButton_clicked</h4>
301 <b>on_removeFiltersButton_clicked</b>(<i></i>)
302 <p>
303 Private slot to remove the selected filters.
304 </p><a NAME="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked"></a>
305 <h4>QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked</h4>
306 <b>on_resetFilterChangesButton_clicked</b>(<i></i>)
307 <p>
308 Private slot to forget the filter changes and reset the tab.
309 </p><a NAME="QtHelpDocumentationDialog.on_tabWidget_currentChanged" ID="QtHelpDocumentationDialog.on_tabWidget_currentChanged"></a>
310 <h4>QtHelpDocumentationDialog.on_tabWidget_currentChanged</h4>
311 <b>on_tabWidget_currentChanged</b>(<i>index</i>)
312 <p>
313 Private slot handling a change of the current tab.
314 </p><dl>
315 <dt><i>index</i> (int)</dt>
316 <dd>
317 index of the current tab
318 </dd>
319 </dl><a NAME="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked"></a>
320 <h4>QtHelpDocumentationDialog.on_unusedAttributesButton_clicked</h4>
321 <b>on_unusedAttributesButton_clicked</b>(<i></i>)
322 <p>
323 Private slot to select all unused attributes.
161 </p> 324 </p>
162 <div align="right"><a href="#top">Up</a></div> 325 <div align="right"><a href="#top">Up</a></div>
163 <hr /> 326 <hr />
164 </body></html> 327 </body></html>

Mercurial Repository: eric

eric ide

mercurial