Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html

src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget</h1> 9 <h1>eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a widget to manage the QtHelp documentation settings. 11 Module implementing a widget to manage the QtHelp documentation settings.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#QtHelpDocumentationSettingsWidget">QtHelpDocumentationSettingsWidget</a></td> 22 <td><a href="#QtHelpDocumentationSettingsWidget">QtHelpDocumentationSettingsWidget</a></td>
25 <td>Class implementing a widget to manage the QtHelp documentation settings.</td> 23 <td>Class implementing a widget to manage the QtHelp documentation settings.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="QtHelpDocumentationSettingsWidget" ID="QtHelpDocumentationSettingsWidget"></a> 34 <a NAME="QtHelpDocumentationSettingsWidget" ID="QtHelpDocumentationSettingsWidget"></a>
36 <h2>QtHelpDocumentationSettingsWidget</h2> 35 <h2>QtHelpDocumentationSettingsWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a widget to manage the QtHelp documentation settings. 37 Class implementing a widget to manage the QtHelp documentation settings.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>documentationSettingsChanged(settings)</dt> 43 <dt>documentationSettingsChanged(settings)</dt>
45 <dd> 44 <dd>
48 </dd> 47 </dd>
49 </dl> 48 </dl>
50 <h3>Derived from</h3> 49 <h3>Derived from</h3>
51 QWidget, Ui_QtHelpDocumentationSettingsWidget 50 QWidget, Ui_QtHelpDocumentationSettingsWidget
52 <h3>Class Attributes</h3> 51 <h3>Class Attributes</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Class Methods</h3> 56 <h3>Class Methods</h3>
58 57 <table>
59 <table> 58 <tr><td>None</td></tr>
60 <tr><td>None</td></tr> 59 </table>
61 </table> 60
62 <h3>Methods</h3> 61 <h3>Methods</h3>
63 62 <table>
64 <table>
65
66 <tr> 63 <tr>
67 <td><a href="#QtHelpDocumentationSettingsWidget.__init__">QtHelpDocumentationSettingsWidget</a></td> 64 <td><a href="#QtHelpDocumentationSettingsWidget.__init__">QtHelpDocumentationSettingsWidget</a></td>
68 <td>Constructor</td> 65 <td>Constructor</td>
69 </tr> 66 </tr>
70 <tr> 67 <tr>
106 <tr> 103 <tr>
107 <td><a href="#QtHelpDocumentationSettingsWidget.setDocumentationSettings">setDocumentationSettings</a></td> 104 <td><a href="#QtHelpDocumentationSettingsWidget.setDocumentationSettings">setDocumentationSettings</a></td>
108 <td>Public method to set the reference to the QtHelp documentation configuration object.</td> 105 <td>Public method to set the reference to the QtHelp documentation configuration object.</td>
109 </tr> 106 </tr>
110 </table> 107 </table>
108
111 <h3>Static Methods</h3> 109 <h3>Static Methods</h3>
112 110 <table>
113 <table> 111 <tr><td>None</td></tr>
114 <tr><td>None</td></tr> 112 </table>
115 </table> 113
116 114
117 <a NAME="QtHelpDocumentationSettingsWidget.__init__" ID="QtHelpDocumentationSettingsWidget.__init__"></a> 115 <a NAME="QtHelpDocumentationSettingsWidget.__init__" ID="QtHelpDocumentationSettingsWidget.__init__"></a>
118 <h4>QtHelpDocumentationSettingsWidget (Constructor)</h4> 116 <h4>QtHelpDocumentationSettingsWidget (Constructor)</h4>
119 <b>QtHelpDocumentationSettingsWidget</b>(<i>parent=None</i>) 117 <b>QtHelpDocumentationSettingsWidget</b>(<i>parent=None</i>)
120
121 <p> 118 <p>
122 Constructor 119 Constructor
123 </p> 120 </p>
121
124 <dl> 122 <dl>
125 123
126 <dt><i>parent</i> (QWidget (optional))</dt> 124 <dt><i>parent</i> (QWidget (optional))</dt>
127 <dd> 125 <dd>
128 reference to the parent widget (defaults to None) 126 reference to the parent widget (defaults to None)
129 </dd> 127 </dd>
130 </dl> 128 </dl>
131 <a NAME="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter" ID="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter"></a> 129 <a NAME="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter" ID="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter"></a>
132 <h4>QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter</h4> 130 <h4>QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter</h4>
133 <b>__applyDocumentsListFilter</b>(<i></i>) 131 <b>__applyDocumentsListFilter</b>(<i></i>)
134
135 <p> 132 <p>
136 Private slot to apply the current documents filter. 133 Private slot to apply the current documents filter.
137 </p> 134 </p>
135
138 <a NAME="QtHelpDocumentationSettingsWidget.__registerDocumentation" ID="QtHelpDocumentationSettingsWidget.__registerDocumentation"></a> 136 <a NAME="QtHelpDocumentationSettingsWidget.__registerDocumentation" ID="QtHelpDocumentationSettingsWidget.__registerDocumentation"></a>
139 <h4>QtHelpDocumentationSettingsWidget.__registerDocumentation</h4> 137 <h4>QtHelpDocumentationSettingsWidget.__registerDocumentation</h4>
140 <b>__registerDocumentation</b>(<i>filenames</i>) 138 <b>__registerDocumentation</b>(<i>filenames</i>)
141
142 <p> 139 <p>
143 Private method to register a given list of documentations. 140 Private method to register a given list of documentations.
144 </p> 141 </p>
142
145 <dl> 143 <dl>
146 144
147 <dt><i>filenames</i> (list of str)</dt> 145 <dt><i>filenames</i> (list of str)</dt>
148 <dd> 146 <dd>
149 list of documentation files to be registered 147 list of documentation files to be registered
150 </dd> 148 </dd>
151 </dl> 149 </dl>
152 <a NAME="QtHelpDocumentationSettingsWidget.documentationSettings" ID="QtHelpDocumentationSettingsWidget.documentationSettings"></a> 150 <a NAME="QtHelpDocumentationSettingsWidget.documentationSettings" ID="QtHelpDocumentationSettingsWidget.documentationSettings"></a>
153 <h4>QtHelpDocumentationSettingsWidget.documentationSettings</h4> 151 <h4>QtHelpDocumentationSettingsWidget.documentationSettings</h4>
154 <b>documentationSettings</b>(<i></i>) 152 <b>documentationSettings</b>(<i></i>)
155
156 <p> 153 <p>
157 Public method to get the reference to the QtHelp documentation 154 Public method to get the reference to the QtHelp documentation
158 configuration object. 155 configuration object.
159 </p> 156 </p>
157
160 <dl> 158 <dl>
161 <dt>Return:</dt> 159 <dt>Return:</dt>
162 <dd> 160 <dd>
163 reference to the created QtHelpDocumentationSettings object 161 reference to the created QtHelpDocumentationSettings object
164 </dd> 162 </dd>
170 </dd> 168 </dd>
171 </dl> 169 </dl>
172 <a NAME="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked"></a> 170 <a NAME="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked"></a>
173 <h4>QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked</h4> 171 <h4>QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked</h4>
174 <b>on_addDocumentsButton_clicked</b>(<i></i>) 172 <b>on_addDocumentsButton_clicked</b>(<i></i>)
175
176 <p> 173 <p>
177 Private slot to add QtHelp documents to the help database. 174 Private slot to add QtHelp documents to the help database.
178 </p> 175 </p>
176
179 <a NAME="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked"></a> 177 <a NAME="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked"></a>
180 <h4>QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked</h4> 178 <h4>QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked</h4>
181 <b>on_addPluginButton_clicked</b>(<i></i>) 179 <b>on_addPluginButton_clicked</b>(<i></i>)
182
183 <p> 180 <p>
184 Private slot to add QtHelp documents provided by plug-ins to 181 Private slot to add QtHelp documents provided by plug-ins to
185 the help database. 182 the help database.
186 </p> 183 </p>
184
187 <a NAME="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged"></a> 185 <a NAME="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged"></a>
188 <h4>QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged</h4> 186 <h4>QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged</h4>
189 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) 187 <b>on_documentsList_itemSelectionChanged</b>(<i></i>)
190
191 <p> 188 <p>
192 Private slot handling a change of the documents selection. 189 Private slot handling a change of the documents selection.
193 </p> 190 </p>
191
194 <a NAME="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged" ID="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged"></a> 192 <a NAME="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged" ID="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged"></a>
195 <h4>QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged</h4> 193 <h4>QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged</h4>
196 <b>on_filterEdit_textChanged</b>(<i>txt</i>) 194 <b>on_filterEdit_textChanged</b>(<i>txt</i>)
197
198 <p> 195 <p>
199 Private slot to react on changes of the document filter text. 196 Private slot to react on changes of the document filter text.
200 </p> 197 </p>
198
201 <dl> 199 <dl>
202 200
203 <dt><i>txt</i> (str)</dt> 201 <dt><i>txt</i> (str)</dt>
204 <dd> 202 <dd>
205 current entry of the filter 203 current entry of the filter
206 </dd> 204 </dd>
207 </dl> 205 </dl>
208 <a NAME="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked"></a> 206 <a NAME="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked"></a>
209 <h4>QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked</h4> 207 <h4>QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked</h4>
210 <b>on_managePluginButton_clicked</b>(<i></i>) 208 <b>on_managePluginButton_clicked</b>(<i></i>)
211
212 <p> 209 <p>
213 Private slot to manage the QtHelp documents provided by plug-ins. 210 Private slot to manage the QtHelp documents provided by plug-ins.
214 </p> 211 </p>
212
215 <a NAME="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked"></a> 213 <a NAME="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked"></a>
216 <h4>QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked</h4> 214 <h4>QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked</h4>
217 <b>on_removeDocumentsButton_clicked</b>(<i></i>) 215 <b>on_removeDocumentsButton_clicked</b>(<i></i>)
218
219 <p> 216 <p>
220 Private slot to remove a document from the help database. 217 Private slot to remove a document from the help database.
221 </p> 218 </p>
219
222 <a NAME="QtHelpDocumentationSettingsWidget.setDocumentationSettings" ID="QtHelpDocumentationSettingsWidget.setDocumentationSettings"></a> 220 <a NAME="QtHelpDocumentationSettingsWidget.setDocumentationSettings" ID="QtHelpDocumentationSettingsWidget.setDocumentationSettings"></a>
223 <h4>QtHelpDocumentationSettingsWidget.setDocumentationSettings</h4> 221 <h4>QtHelpDocumentationSettingsWidget.setDocumentationSettings</h4>
224 <b>setDocumentationSettings</b>(<i>settings</i>) 222 <b>setDocumentationSettings</b>(<i>settings</i>)
225
226 <p> 223 <p>
227 Public method to set the reference to the QtHelp documentation 224 Public method to set the reference to the QtHelp documentation
228 configuration object. 225 configuration object.
229 </p> 226 </p>
227
230 <dl> 228 <dl>
231 229
232 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt> 230 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt>
233 <dd> 231 <dd>
234 reference to the created QtHelpDocumentationSettings 232 reference to the created QtHelpDocumentationSettings

Mercurial Repository: eric

eric ide

mercurial