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

changeset 7273
391d6b7b1eff
parent 7232
0b840f7ed593
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog</h1> 23 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to manage the QtHelp documentation database. 26 Module implementing a dialog to manage the QtHelp documentation database.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> 38 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td>
34 <td>Class implementing a dialog to manage the QtHelp documentation database.</td> 39 <td>Class implementing a dialog to manage the QtHelp documentation database.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> 49 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a>
43 <h2>QtHelpDocumentationDialog</h2> 50 <h2>QtHelpDocumentationDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to manage the QtHelp documentation database. 53 Class implementing a dialog to manage the QtHelp documentation database.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_QtHelpDocumentationDialog 56 QDialog, Ui_QtHelpDocumentationDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> 72 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#QtHelpDocumentationDialog.__hasChangedFilters">__hasChangedFilters</a></td> 76 <td><a href="#QtHelpDocumentationDialog.__hasChangedFilters">__hasChangedFilters</a></td>
64 <td>Private method to determine, if there are filter changes.</td> 77 <td>Private method to determine, if there are filter changes.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#QtHelpDocumentationDialog.__initDocumentsTab">__initDocumentsTab</a></td> 80 <td><a href="#QtHelpDocumentationDialog.__initDocumentsTab">__initDocumentsTab</a></td>
67 <td>Private method to initialize the documents tab.</td> 81 <td>Private method to initialize the documents tab.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#QtHelpDocumentationDialog.__initFiltersTab">__initFiltersTab</a></td> 84 <td><a href="#QtHelpDocumentationDialog.__initFiltersTab">__initFiltersTab</a></td>
70 <td>Private method to initialize the filters tab.</td> 85 <td>Private method to initialize the filters tab.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#QtHelpDocumentationDialog.__registerDocumentations">__registerDocumentations</a></td> 88 <td><a href="#QtHelpDocumentationDialog.__registerDocumentations">__registerDocumentations</a></td>
73 <td>Private method to register a given list of documentations.</td> 89 <td>Private method to register a given list of documentations.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#QtHelpDocumentationDialog.__removeAttributes">__removeAttributes</a></td> 92 <td><a href="#QtHelpDocumentationDialog.__removeAttributes">__removeAttributes</a></td>
76 <td>Private method to remove attributes from the Qt Help database.</td> 93 <td>Private method to remove attributes from the Qt Help database.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> 96 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td>
79 <td>Public method to get the list of tabs to close.</td> 97 <td>Public method to get the list of tabs to close.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#QtHelpDocumentationDialog.hasDocumentationChanges">hasDocumentationChanges</a></td> 100 <td><a href="#QtHelpDocumentationDialog.hasDocumentationChanges">hasDocumentationChanges</a></td>
82 <td>Public slot to test the dialog for changes of configured QtHelp documents.</td> 101 <td>Public slot to test the dialog for changes of configured QtHelp documents.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#QtHelpDocumentationDialog.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td> 104 <td><a href="#QtHelpDocumentationDialog.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td>
85 <td>Private slot to add QtHelp documents to the help database.</td> 105 <td>Private slot to add QtHelp documents to the help database.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#QtHelpDocumentationDialog.on_addFilterButton_clicked">on_addFilterButton_clicked</a></td> 108 <td><a href="#QtHelpDocumentationDialog.on_addFilterButton_clicked">on_addFilterButton_clicked</a></td>
88 <td>Private slot to add a new filter.</td> 109 <td>Private slot to add a new filter.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td> 112 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td>
91 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td> 113 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked">on_applyFilterChangesButton_clicked</a></td> 116 <td><a href="#QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked">on_applyFilterChangesButton_clicked</a></td>
94 <td>Private slot to apply the filter changes.</td> 117 <td>Private slot to apply the filter changes.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemChanged">on_attributesList_itemChanged</a></td> 120 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemChanged">on_attributesList_itemChanged</a></td>
97 <td>Private slot to handle a change of an attribute.</td> 121 <td>Private slot to handle a change of an attribute.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged">on_attributesList_itemSelectionChanged</a></td> 124 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged">on_attributesList_itemSelectionChanged</a></td>
100 <td>Private slot handling the selection of attributes.</td> 125 <td>Private slot handling the selection of attributes.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> 128 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td>
103 <td>Private slot handling a change of the documents selection.</td> 129 <td>Private slot handling a change of the documents selection.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#QtHelpDocumentationDialog.on_filtersList_currentItemChanged">on_filtersList_currentItemChanged</a></td> 132 <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> 133 <td>Private slot to update the attributes depending on the current filter.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged">on_filtersList_itemSelectionChanged</a></td> 136 <td><a href="#QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged">on_filtersList_itemSelectionChanged</a></td>
109 <td>Private slot handling a change of selected filters.</td> 137 <td>Private slot handling a change of selected filters.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td> 140 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td>
112 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td> 141 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#QtHelpDocumentationDialog.on_removeAttributesButton_clicked">on_removeAttributesButton_clicked</a></td> 144 <td><a href="#QtHelpDocumentationDialog.on_removeAttributesButton_clicked">on_removeAttributesButton_clicked</a></td>
115 <td>Private slot to remove the selected filter attributes.</td> 145 <td>Private slot to remove the selected filter attributes.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#QtHelpDocumentationDialog.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td> 148 <td><a href="#QtHelpDocumentationDialog.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td>
118 <td>Private slot to remove a document from the help database.</td> 149 <td>Private slot to remove a document from the help database.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#QtHelpDocumentationDialog.on_removeFiltersButton_clicked">on_removeFiltersButton_clicked</a></td> 152 <td><a href="#QtHelpDocumentationDialog.on_removeFiltersButton_clicked">on_removeFiltersButton_clicked</a></td>
121 <td>Private slot to remove the selected filters.</td> 153 <td>Private slot to remove the selected filters.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked">on_resetFilterChangesButton_clicked</a></td> 156 <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> 157 <td>Private slot to forget the filter changes and reset the tab.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#QtHelpDocumentationDialog.on_tabWidget_currentChanged">on_tabWidget_currentChanged</a></td> 160 <td><a href="#QtHelpDocumentationDialog.on_tabWidget_currentChanged">on_tabWidget_currentChanged</a></td>
127 <td>Private slot handling a change of the current tab.</td> 161 <td>Private slot handling a change of the current tab.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#QtHelpDocumentationDialog.on_unusedAttributesButton_clicked">on_unusedAttributesButton_clicked</a></td> 164 <td><a href="#QtHelpDocumentationDialog.on_unusedAttributesButton_clicked">on_unusedAttributesButton_clicked</a></td>
130 <td>Private slot to select all unused attributes.</td> 165 <td>Private slot to select all unused attributes.</td>
131 </tr> 166 </tr>
132 </table> 167 </table>
133 <h3>Static Methods</h3> 168 <h3>Static Methods</h3>
169
134 <table> 170 <table>
135 <tr><td>None</td></tr> 171 <tr><td>None</td></tr>
136 </table> 172 </table>
173
137 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> 174 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a>
138 <h4>QtHelpDocumentationDialog (Constructor)</h4> 175 <h4>QtHelpDocumentationDialog (Constructor)</h4>
139 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) 176 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>)
177
140 <p> 178 <p>
141 Constructor 179 Constructor
142 </p><dl> 180 </p>
181 <dl>
182
143 <dt><i>engine</i></dt> 183 <dt><i>engine</i></dt>
144 <dd> 184 <dd>
145 reference to the help engine (QHelpEngine) 185 reference to the help engine (QHelpEngine)
146 </dd><dt><i>parent</i></dt> 186 </dd>
187 <dt><i>parent</i></dt>
147 <dd> 188 <dd>
148 reference to the parent widget (QWidget) 189 reference to the parent widget (QWidget)
149 </dd> 190 </dd>
150 </dl><a NAME="QtHelpDocumentationDialog.__hasChangedFilters" ID="QtHelpDocumentationDialog.__hasChangedFilters"></a> 191 </dl>
192 <a NAME="QtHelpDocumentationDialog.__hasChangedFilters" ID="QtHelpDocumentationDialog.__hasChangedFilters"></a>
151 <h4>QtHelpDocumentationDialog.__hasChangedFilters</h4> 193 <h4>QtHelpDocumentationDialog.__hasChangedFilters</h4>
152 <b>__hasChangedFilters</b>(<i></i>) 194 <b>__hasChangedFilters</b>(<i></i>)
195
153 <p> 196 <p>
154 Private method to determine, if there are filter changes. 197 Private method to determine, if there are filter changes.
155 </p><dl> 198 </p>
199 <dl>
156 <dt>Returns:</dt> 200 <dt>Returns:</dt>
157 <dd> 201 <dd>
158 flag indicating the presence of filter changes 202 flag indicating the presence of filter changes
159 </dd> 203 </dd>
160 </dl><dl> 204 </dl>
205 <dl>
161 <dt>Return Type:</dt> 206 <dt>Return Type:</dt>
162 <dd> 207 <dd>
163 bool 208 bool
164 </dd> 209 </dd>
165 </dl><a NAME="QtHelpDocumentationDialog.__initDocumentsTab" ID="QtHelpDocumentationDialog.__initDocumentsTab"></a> 210 </dl>
211 <a NAME="QtHelpDocumentationDialog.__initDocumentsTab" ID="QtHelpDocumentationDialog.__initDocumentsTab"></a>
166 <h4>QtHelpDocumentationDialog.__initDocumentsTab</h4> 212 <h4>QtHelpDocumentationDialog.__initDocumentsTab</h4>
167 <b>__initDocumentsTab</b>(<i></i>) 213 <b>__initDocumentsTab</b>(<i></i>)
214
168 <p> 215 <p>
169 Private method to initialize the documents tab. 216 Private method to initialize the documents tab.
170 </p><a NAME="QtHelpDocumentationDialog.__initFiltersTab" ID="QtHelpDocumentationDialog.__initFiltersTab"></a> 217 </p>
218 <a NAME="QtHelpDocumentationDialog.__initFiltersTab" ID="QtHelpDocumentationDialog.__initFiltersTab"></a>
171 <h4>QtHelpDocumentationDialog.__initFiltersTab</h4> 219 <h4>QtHelpDocumentationDialog.__initFiltersTab</h4>
172 <b>__initFiltersTab</b>(<i></i>) 220 <b>__initFiltersTab</b>(<i></i>)
221
173 <p> 222 <p>
174 Private method to initialize the filters tab. 223 Private method to initialize the filters tab.
175 </p><a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a> 224 </p>
225 <a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a>
176 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4> 226 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4>
177 <b>__registerDocumentations</b>(<i>fileNames</i>) 227 <b>__registerDocumentations</b>(<i>fileNames</i>)
228
178 <p> 229 <p>
179 Private method to register a given list of documentations. 230 Private method to register a given list of documentations.
180 </p><dl> 231 </p>
232 <dl>
233
181 <dt><i>fileNames</i> (list of str)</dt> 234 <dt><i>fileNames</i> (list of str)</dt>
182 <dd> 235 <dd>
183 list of documentation files to be registered 236 list of documentation files to be registered
184 </dd> 237 </dd>
185 </dl><a NAME="QtHelpDocumentationDialog.__removeAttributes" ID="QtHelpDocumentationDialog.__removeAttributes"></a> 238 </dl>
239 <a NAME="QtHelpDocumentationDialog.__removeAttributes" ID="QtHelpDocumentationDialog.__removeAttributes"></a>
186 <h4>QtHelpDocumentationDialog.__removeAttributes</h4> 240 <h4>QtHelpDocumentationDialog.__removeAttributes</h4>
187 <b>__removeAttributes</b>(<i></i>) 241 <b>__removeAttributes</b>(<i></i>)
242
188 <p> 243 <p>
189 Private method to remove attributes from the Qt Help database. 244 Private method to remove attributes from the Qt Help database.
190 </p><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> 245 </p>
246 <a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a>
191 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> 247 <h4>QtHelpDocumentationDialog.getTabsToClose</h4>
192 <b>getTabsToClose</b>(<i></i>) 248 <b>getTabsToClose</b>(<i></i>)
249
193 <p> 250 <p>
194 Public method to get the list of tabs to close. 251 Public method to get the list of tabs to close.
195 </p><dl> 252 </p>
253 <dl>
196 <dt>Returns:</dt> 254 <dt>Returns:</dt>
197 <dd> 255 <dd>
198 list of tab ids to be closed 256 list of tab ids to be closed
199 </dd> 257 </dd>
200 </dl><dl> 258 </dl>
259 <dl>
201 <dt>Return Type:</dt> 260 <dt>Return Type:</dt>
202 <dd> 261 <dd>
203 list of int 262 list of int
204 </dd> 263 </dd>
205 </dl><a NAME="QtHelpDocumentationDialog.hasDocumentationChanges" ID="QtHelpDocumentationDialog.hasDocumentationChanges"></a> 264 </dl>
265 <a NAME="QtHelpDocumentationDialog.hasDocumentationChanges" ID="QtHelpDocumentationDialog.hasDocumentationChanges"></a>
206 <h4>QtHelpDocumentationDialog.hasDocumentationChanges</h4> 266 <h4>QtHelpDocumentationDialog.hasDocumentationChanges</h4>
207 <b>hasDocumentationChanges</b>(<i></i>) 267 <b>hasDocumentationChanges</b>(<i></i>)
268
208 <p> 269 <p>
209 Public slot to test the dialog for changes of configured QtHelp 270 Public slot to test the dialog for changes of configured QtHelp
210 documents. 271 documents.
211 </p><dl> 272 </p>
273 <dl>
212 <dt>Returns:</dt> 274 <dt>Returns:</dt>
213 <dd> 275 <dd>
214 flag indicating presence of changes 276 flag indicating presence of changes
215 </dd> 277 </dd>
216 </dl><dl> 278 </dl>
279 <dl>
217 <dt>Return Type:</dt> 280 <dt>Return Type:</dt>
218 <dd> 281 <dd>
219 bool 282 bool
220 </dd> 283 </dd>
221 </dl><a NAME="QtHelpDocumentationDialog.on_addDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_addDocumentsButton_clicked"></a> 284 </dl>
285 <a NAME="QtHelpDocumentationDialog.on_addDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_addDocumentsButton_clicked"></a>
222 <h4>QtHelpDocumentationDialog.on_addDocumentsButton_clicked</h4> 286 <h4>QtHelpDocumentationDialog.on_addDocumentsButton_clicked</h4>
223 <b>on_addDocumentsButton_clicked</b>(<i></i>) 287 <b>on_addDocumentsButton_clicked</b>(<i></i>)
288
224 <p> 289 <p>
225 Private slot to add QtHelp documents to the help database. 290 Private slot to add QtHelp documents to the help database.
226 </p><a NAME="QtHelpDocumentationDialog.on_addFilterButton_clicked" ID="QtHelpDocumentationDialog.on_addFilterButton_clicked"></a> 291 </p>
292 <a NAME="QtHelpDocumentationDialog.on_addFilterButton_clicked" ID="QtHelpDocumentationDialog.on_addFilterButton_clicked"></a>
227 <h4>QtHelpDocumentationDialog.on_addFilterButton_clicked</h4> 293 <h4>QtHelpDocumentationDialog.on_addFilterButton_clicked</h4>
228 <b>on_addFilterButton_clicked</b>(<i></i>) 294 <b>on_addFilterButton_clicked</b>(<i></i>)
295
229 <p> 296 <p>
230 Private slot to add a new filter. 297 Private slot to add a new filter.
231 </p><a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a> 298 </p>
299 <a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a>
232 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4> 300 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4>
233 <b>on_addPluginButton_clicked</b>(<i></i>) 301 <b>on_addPluginButton_clicked</b>(<i></i>)
302
234 <p> 303 <p>
235 Private slot to add QtHelp documents provided by plug-ins to 304 Private slot to add QtHelp documents provided by plug-ins to
236 the help database. 305 the help database.
237 </p><a NAME="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked"></a> 306 </p>
307 <a NAME="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked"></a>
238 <h4>QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked</h4> 308 <h4>QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked</h4>
239 <b>on_applyFilterChangesButton_clicked</b>(<i></i>) 309 <b>on_applyFilterChangesButton_clicked</b>(<i></i>)
310
240 <p> 311 <p>
241 Private slot to apply the filter changes. 312 Private slot to apply the filter changes.
242 </p><a NAME="QtHelpDocumentationDialog.on_attributesList_itemChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemChanged"></a> 313 </p>
314 <a NAME="QtHelpDocumentationDialog.on_attributesList_itemChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemChanged"></a>
243 <h4>QtHelpDocumentationDialog.on_attributesList_itemChanged</h4> 315 <h4>QtHelpDocumentationDialog.on_attributesList_itemChanged</h4>
244 <b>on_attributesList_itemChanged</b>(<i>item, column</i>) 316 <b>on_attributesList_itemChanged</b>(<i>item, column</i>)
317
245 <p> 318 <p>
246 Private slot to handle a change of an attribute. 319 Private slot to handle a change of an attribute.
247 </p><dl> 320 </p>
321 <dl>
322
248 <dt><i>item</i></dt> 323 <dt><i>item</i></dt>
249 <dd> 324 <dd>
250 reference to the changed item (QTreeWidgetItem) 325 reference to the changed item (QTreeWidgetItem)
251 </dd><dt><i>column</i></dt> 326 </dd>
327 <dt><i>column</i></dt>
252 <dd> 328 <dd>
253 column containing the change (integer) 329 column containing the change (integer)
254 </dd> 330 </dd>
255 </dl><a NAME="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged"></a> 331 </dl>
332 <a NAME="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged"></a>
256 <h4>QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged</h4> 333 <h4>QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged</h4>
257 <b>on_attributesList_itemSelectionChanged</b>(<i></i>) 334 <b>on_attributesList_itemSelectionChanged</b>(<i></i>)
335
258 <p> 336 <p>
259 Private slot handling the selection of attributes. 337 Private slot handling the selection of attributes.
260 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> 338 </p>
339 <a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a>
261 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> 340 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4>
262 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) 341 <b>on_documentsList_itemSelectionChanged</b>(<i></i>)
342
263 <p> 343 <p>
264 Private slot handling a change of the documents selection. 344 Private slot handling a change of the documents selection.
265 </p><a NAME="QtHelpDocumentationDialog.on_filtersList_currentItemChanged" ID="QtHelpDocumentationDialog.on_filtersList_currentItemChanged"></a> 345 </p>
346 <a NAME="QtHelpDocumentationDialog.on_filtersList_currentItemChanged" ID="QtHelpDocumentationDialog.on_filtersList_currentItemChanged"></a>
266 <h4>QtHelpDocumentationDialog.on_filtersList_currentItemChanged</h4> 347 <h4>QtHelpDocumentationDialog.on_filtersList_currentItemChanged</h4>
267 <b>on_filtersList_currentItemChanged</b>(<i>current, previous</i>) 348 <b>on_filtersList_currentItemChanged</b>(<i>current, previous</i>)
349
268 <p> 350 <p>
269 Private slot to update the attributes depending on the current filter. 351 Private slot to update the attributes depending on the current filter.
270 </p><dl> 352 </p>
353 <dl>
354
271 <dt><i>current</i></dt> 355 <dt><i>current</i></dt>
272 <dd> 356 <dd>
273 reference to the current item (QListWidgetitem) 357 reference to the current item (QListWidgetitem)
274 </dd><dt><i>previous</i></dt> 358 </dd>
359 <dt><i>previous</i></dt>
275 <dd> 360 <dd>
276 reference to the previous current item 361 reference to the previous current item
277 (QListWidgetItem) 362 (QListWidgetItem)
278 </dd> 363 </dd>
279 </dl><a NAME="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged"></a> 364 </dl>
365 <a NAME="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged"></a>
280 <h4>QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged</h4> 366 <h4>QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged</h4>
281 <b>on_filtersList_itemSelectionChanged</b>(<i></i>) 367 <b>on_filtersList_itemSelectionChanged</b>(<i></i>)
368
282 <p> 369 <p>
283 Private slot handling a change of selected filters. 370 Private slot handling a change of selected filters.
284 </p><a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a> 371 </p>
372 <a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a>
285 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4> 373 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4>
286 <b>on_managePluginButton_clicked</b>(<i></i>) 374 <b>on_managePluginButton_clicked</b>(<i></i>)
375
287 <p> 376 <p>
288 Private slot to manage the QtHelp documents provided by plug-ins. 377 Private slot to manage the QtHelp documents provided by plug-ins.
289 </p><a NAME="QtHelpDocumentationDialog.on_removeAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_removeAttributesButton_clicked"></a> 378 </p>
379 <a NAME="QtHelpDocumentationDialog.on_removeAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_removeAttributesButton_clicked"></a>
290 <h4>QtHelpDocumentationDialog.on_removeAttributesButton_clicked</h4> 380 <h4>QtHelpDocumentationDialog.on_removeAttributesButton_clicked</h4>
291 <b>on_removeAttributesButton_clicked</b>(<i></i>) 381 <b>on_removeAttributesButton_clicked</b>(<i></i>)
382
292 <p> 383 <p>
293 Private slot to remove the selected filter attributes. 384 Private slot to remove the selected filter attributes.
294 </p><a NAME="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked"></a> 385 </p>
386 <a NAME="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked"></a>
295 <h4>QtHelpDocumentationDialog.on_removeDocumentsButton_clicked</h4> 387 <h4>QtHelpDocumentationDialog.on_removeDocumentsButton_clicked</h4>
296 <b>on_removeDocumentsButton_clicked</b>(<i></i>) 388 <b>on_removeDocumentsButton_clicked</b>(<i></i>)
389
297 <p> 390 <p>
298 Private slot to remove a document from the help database. 391 Private slot to remove a document from the help database.
299 </p><a NAME="QtHelpDocumentationDialog.on_removeFiltersButton_clicked" ID="QtHelpDocumentationDialog.on_removeFiltersButton_clicked"></a> 392 </p>
393 <a NAME="QtHelpDocumentationDialog.on_removeFiltersButton_clicked" ID="QtHelpDocumentationDialog.on_removeFiltersButton_clicked"></a>
300 <h4>QtHelpDocumentationDialog.on_removeFiltersButton_clicked</h4> 394 <h4>QtHelpDocumentationDialog.on_removeFiltersButton_clicked</h4>
301 <b>on_removeFiltersButton_clicked</b>(<i></i>) 395 <b>on_removeFiltersButton_clicked</b>(<i></i>)
396
302 <p> 397 <p>
303 Private slot to remove the selected filters. 398 Private slot to remove the selected filters.
304 </p><a NAME="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked"></a> 399 </p>
400 <a NAME="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked"></a>
305 <h4>QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked</h4> 401 <h4>QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked</h4>
306 <b>on_resetFilterChangesButton_clicked</b>(<i></i>) 402 <b>on_resetFilterChangesButton_clicked</b>(<i></i>)
403
307 <p> 404 <p>
308 Private slot to forget the filter changes and reset the tab. 405 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> 406 </p>
407 <a NAME="QtHelpDocumentationDialog.on_tabWidget_currentChanged" ID="QtHelpDocumentationDialog.on_tabWidget_currentChanged"></a>
310 <h4>QtHelpDocumentationDialog.on_tabWidget_currentChanged</h4> 408 <h4>QtHelpDocumentationDialog.on_tabWidget_currentChanged</h4>
311 <b>on_tabWidget_currentChanged</b>(<i>index</i>) 409 <b>on_tabWidget_currentChanged</b>(<i>index</i>)
410
312 <p> 411 <p>
313 Private slot handling a change of the current tab. 412 Private slot handling a change of the current tab.
314 </p><dl> 413 </p>
414 <dl>
415
315 <dt><i>index</i> (int)</dt> 416 <dt><i>index</i> (int)</dt>
316 <dd> 417 <dd>
317 index of the current tab 418 index of the current tab
318 </dd> 419 </dd>
319 </dl><a NAME="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked"></a> 420 </dl>
421 <a NAME="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked"></a>
320 <h4>QtHelpDocumentationDialog.on_unusedAttributesButton_clicked</h4> 422 <h4>QtHelpDocumentationDialog.on_unusedAttributesButton_clicked</h4>
321 <b>on_unusedAttributesButton_clicked</b>(<i></i>) 423 <b>on_unusedAttributesButton_clicked</b>(<i></i>)
424
322 <p> 425 <p>
323 Private slot to select all unused attributes. 426 Private slot to select all unused attributes.
324 </p> 427 </p>
325 <div align="right"><a href="#top">Up</a></div> 428 <div align="right"><a href="#top">Up</a></div>
326 <hr /> 429 <hr />

eric ide

mercurial