Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
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.QtHelpDocumentationSettings</h1> 9 <h1>eric7.QtHelpInterface.QtHelpDocumentationSettings</h1>
10
11 <p> 10 <p>
12 Module implementing a class to store the QtHelp documentation settings before 11 Module implementing a class to store the QtHelp documentation settings before
13 being applied to the help engine. 12 being applied to the help engine.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#QtHelpDocumentationSettings">QtHelpDocumentationSettings</a></td> 23 <td><a href="#QtHelpDocumentationSettings">QtHelpDocumentationSettings</a></td>
26 <td>Class implementing a temporary store for QtHelp documentation settings.</td> 24 <td>Class implementing a temporary store for QtHelp documentation settings.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="QtHelpDocumentationSettings" ID="QtHelpDocumentationSettings"></a> 35 <a NAME="QtHelpDocumentationSettings" ID="QtHelpDocumentationSettings"></a>
37 <h2>QtHelpDocumentationSettings</h2> 36 <h2>QtHelpDocumentationSettings</h2>
38
39 <p> 37 <p>
40 Class implementing a temporary store for QtHelp documentation settings. 38 Class implementing a temporary store for QtHelp documentation settings.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 None 42 None
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45
46 <table> 44 <table>
47 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
48 </table> 46 </table>
47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50
51 <table> 49 <table>
52 <tr><td>None</td></tr> 50 <tr><td>None</td></tr>
53 </table> 51 </table>
52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#QtHelpDocumentationSettings.__init__">QtHelpDocumentationSettings</a></td> 56 <td><a href="#QtHelpDocumentationSettings.__init__">QtHelpDocumentationSettings</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
86 <tr> 83 <tr>
87 <td><a href="#QtHelpDocumentationSettings.versions">versions</a></td> 84 <td><a href="#QtHelpDocumentationSettings.versions">versions</a></td>
88 <td>Public method to get the list of versions.</td> 85 <td>Public method to get the list of versions.</td>
89 </tr> 86 </tr>
90 </table> 87 </table>
88
91 <h3>Static Methods</h3> 89 <h3>Static Methods</h3>
92 90 <table>
93 <table>
94
95 <tr> 91 <tr>
96 <td><a href="#QtHelpDocumentationSettings.applySettings">applySettings</a></td> 92 <td><a href="#QtHelpDocumentationSettings.applySettings">applySettings</a></td>
97 <td>Static method to apply the changed QtHelp documentation configuration.</td> 93 <td>Static method to apply the changed QtHelp documentation configuration.</td>
98 </tr> 94 </tr>
99 <tr> 95 <tr>
100 <td><a href="#QtHelpDocumentationSettings.readSettings">readSettings</a></td> 96 <td><a href="#QtHelpDocumentationSettings.readSettings">readSettings</a></td>
101 <td>Static method to read the QtHelp documentation configuration.</td> 97 <td>Static method to read the QtHelp documentation configuration.</td>
102 </tr> 98 </tr>
103 </table> 99 </table>
100
104 101
105 <a NAME="QtHelpDocumentationSettings.__init__" ID="QtHelpDocumentationSettings.__init__"></a> 102 <a NAME="QtHelpDocumentationSettings.__init__" ID="QtHelpDocumentationSettings.__init__"></a>
106 <h4>QtHelpDocumentationSettings (Constructor)</h4> 103 <h4>QtHelpDocumentationSettings (Constructor)</h4>
107 <b>QtHelpDocumentationSettings</b>(<i></i>) 104 <b>QtHelpDocumentationSettings</b>(<i></i>)
108
109 <p> 105 <p>
110 Constructor 106 Constructor
111 </p> 107 </p>
108
112 <a NAME="QtHelpDocumentationSettings.addDocumentation" ID="QtHelpDocumentationSettings.addDocumentation"></a> 109 <a NAME="QtHelpDocumentationSettings.addDocumentation" ID="QtHelpDocumentationSettings.addDocumentation"></a>
113 <h4>QtHelpDocumentationSettings.addDocumentation</h4> 110 <h4>QtHelpDocumentationSettings.addDocumentation</h4>
114 <b>addDocumentation</b>(<i>filename</i>) 111 <b>addDocumentation</b>(<i>filename</i>)
115
116 <p> 112 <p>
117 Public method to a add a documentation file to the list. 113 Public method to a add a documentation file to the list.
118 </p> 114 </p>
115
119 <dl> 116 <dl>
120 117
121 <dt><i>filename</i> (str)</dt> 118 <dt><i>filename</i> (str)</dt>
122 <dd> 119 <dd>
123 name of the documentation file to add 120 name of the documentation file to add
136 </dd> 133 </dd>
137 </dl> 134 </dl>
138 <a NAME="QtHelpDocumentationSettings.components" ID="QtHelpDocumentationSettings.components"></a> 135 <a NAME="QtHelpDocumentationSettings.components" ID="QtHelpDocumentationSettings.components"></a>
139 <h4>QtHelpDocumentationSettings.components</h4> 136 <h4>QtHelpDocumentationSettings.components</h4>
140 <b>components</b>(<i></i>) 137 <b>components</b>(<i></i>)
141
142 <p> 138 <p>
143 Public method to get the list of components. 139 Public method to get the list of components.
144 </p> 140 </p>
141
145 <dl> 142 <dl>
146 <dt>Return:</dt> 143 <dt>Return:</dt>
147 <dd> 144 <dd>
148 list of components 145 list of components
149 </dd> 146 </dd>
155 </dd> 152 </dd>
156 </dl> 153 </dl>
157 <a NAME="QtHelpDocumentationSettings.namespace" ID="QtHelpDocumentationSettings.namespace"></a> 154 <a NAME="QtHelpDocumentationSettings.namespace" ID="QtHelpDocumentationSettings.namespace"></a>
158 <h4>QtHelpDocumentationSettings.namespace</h4> 155 <h4>QtHelpDocumentationSettings.namespace</h4>
159 <b>namespace</b>(<i>filename</i>) 156 <b>namespace</b>(<i>filename</i>)
160
161 <p> 157 <p>
162 Public method to get the namespace defined by a QtHelp file. 158 Public method to get the namespace defined by a QtHelp file.
163 </p> 159 </p>
160
164 <dl> 161 <dl>
165 162
166 <dt><i>filename</i> (str)</dt> 163 <dt><i>filename</i> (str)</dt>
167 <dd> 164 <dd>
168 name of the QtHelp file 165 name of the QtHelp file
181 </dd> 178 </dd>
182 </dl> 179 </dl>
183 <a NAME="QtHelpDocumentationSettings.namespaceToFilename" ID="QtHelpDocumentationSettings.namespaceToFilename"></a> 180 <a NAME="QtHelpDocumentationSettings.namespaceToFilename" ID="QtHelpDocumentationSettings.namespaceToFilename"></a>
184 <h4>QtHelpDocumentationSettings.namespaceToFilename</h4> 181 <h4>QtHelpDocumentationSettings.namespaceToFilename</h4>
185 <b>namespaceToFilename</b>(<i></i>) 182 <b>namespaceToFilename</b>(<i></i>)
186
187 <p> 183 <p>
188 Public method to get the namespace to filename mapping. 184 Public method to get the namespace to filename mapping.
189 </p> 185 </p>
186
190 <dl> 187 <dl>
191 <dt>Return:</dt> 188 <dt>Return:</dt>
192 <dd> 189 <dd>
193 dictionary containing the namespace to filename mapping 190 dictionary containing the namespace to filename mapping
194 </dd> 191 </dd>
200 </dd> 197 </dd>
201 </dl> 198 </dl>
202 <a NAME="QtHelpDocumentationSettings.namespaces" ID="QtHelpDocumentationSettings.namespaces"></a> 199 <a NAME="QtHelpDocumentationSettings.namespaces" ID="QtHelpDocumentationSettings.namespaces"></a>
203 <h4>QtHelpDocumentationSettings.namespaces</h4> 200 <h4>QtHelpDocumentationSettings.namespaces</h4>
204 <b>namespaces</b>(<i></i>) 201 <b>namespaces</b>(<i></i>)
205
206 <p> 202 <p>
207 Public method to get the list of namespaces. 203 Public method to get the list of namespaces.
208 </p> 204 </p>
205
209 <dl> 206 <dl>
210 <dt>Return:</dt> 207 <dt>Return:</dt>
211 <dd> 208 <dd>
212 list of namespaces 209 list of namespaces
213 </dd> 210 </dd>
219 </dd> 216 </dd>
220 </dl> 217 </dl>
221 <a NAME="QtHelpDocumentationSettings.removeDocumentation" ID="QtHelpDocumentationSettings.removeDocumentation"></a> 218 <a NAME="QtHelpDocumentationSettings.removeDocumentation" ID="QtHelpDocumentationSettings.removeDocumentation"></a>
222 <h4>QtHelpDocumentationSettings.removeDocumentation</h4> 219 <h4>QtHelpDocumentationSettings.removeDocumentation</h4>
223 <b>removeDocumentation</b>(<i>namespace</i>) 220 <b>removeDocumentation</b>(<i>namespace</i>)
224
225 <p> 221 <p>
226 Public method to remove the documentation of a given namespace. 222 Public method to remove the documentation of a given namespace.
227 </p> 223 </p>
224
228 <dl> 225 <dl>
229 226
230 <dt><i>namespace</i> (str)</dt> 227 <dt><i>namespace</i> (str)</dt>
231 <dd> 228 <dd>
232 name of the namespace 229 name of the namespace
245 </dd> 242 </dd>
246 </dl> 243 </dl>
247 <a NAME="QtHelpDocumentationSettings.versions" ID="QtHelpDocumentationSettings.versions"></a> 244 <a NAME="QtHelpDocumentationSettings.versions" ID="QtHelpDocumentationSettings.versions"></a>
248 <h4>QtHelpDocumentationSettings.versions</h4> 245 <h4>QtHelpDocumentationSettings.versions</h4>
249 <b>versions</b>(<i></i>) 246 <b>versions</b>(<i></i>)
250
251 <p> 247 <p>
252 Public method to get the list of versions. 248 Public method to get the list of versions.
253 </p> 249 </p>
250
254 <dl> 251 <dl>
255 <dt>Return:</dt> 252 <dt>Return:</dt>
256 <dd> 253 <dd>
257 list of versions 254 list of versions
258 </dd> 255 </dd>
264 </dd> 261 </dd>
265 </dl> 262 </dl>
266 <a NAME="QtHelpDocumentationSettings.applySettings" ID="QtHelpDocumentationSettings.applySettings"></a> 263 <a NAME="QtHelpDocumentationSettings.applySettings" ID="QtHelpDocumentationSettings.applySettings"></a>
267 <h4>QtHelpDocumentationSettings.applySettings (static)</h4> 264 <h4>QtHelpDocumentationSettings.applySettings (static)</h4>
268 <b>applySettings</b>(<i>settings</i>) 265 <b>applySettings</b>(<i>settings</i>)
269
270 <p> 266 <p>
271 Static method to apply the changed QtHelp documentation configuration. 267 Static method to apply the changed QtHelp documentation configuration.
272 </p> 268 </p>
269
273 <dl> 270 <dl>
274 271
275 <dt><i>helpEngine</i> (QHelpEngineCore)</dt> 272 <dt><i>helpEngine</i> (QHelpEngineCore)</dt>
276 <dd> 273 <dd>
277 reference to the QtHelp engine 274 reference to the QtHelp engine
295 </dd> 292 </dd>
296 </dl> 293 </dl>
297 <a NAME="QtHelpDocumentationSettings.readSettings" ID="QtHelpDocumentationSettings.readSettings"></a> 294 <a NAME="QtHelpDocumentationSettings.readSettings" ID="QtHelpDocumentationSettings.readSettings"></a>
298 <h4>QtHelpDocumentationSettings.readSettings (static)</h4> 295 <h4>QtHelpDocumentationSettings.readSettings (static)</h4>
299 <b>readSettings</b>(<i></i>) 296 <b>readSettings</b>(<i></i>)
300
301 <p> 297 <p>
302 Static method to read the QtHelp documentation configuration. 298 Static method to read the QtHelp documentation configuration.
303 </p> 299 </p>
300
304 <dl> 301 <dl>
305 302
306 <dt><i>helpEngine</i> (QHelpEngineCore)</dt> 303 <dt><i>helpEngine</i> (QHelpEngineCore)</dt>
307 <dd> 304 <dd>
308 reference to the QtHelp engine 305 reference to the QtHelp engine

Mercurial Repository: eric

eric ide

mercurial