Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.CodeDocumentationViewer.html

eric6/Documentation/Source/eric6.UI.CodeDocumentationViewer.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7530
9f4fac61e7c7
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.UI.CodeDocumentationViewer</h1> 23 <h1>eric6.UI.CodeDocumentationViewer</h1>
24
23 <p> 25 <p>
24 Module implementing a widget to show some source code information provided by 26 Module implementing a widget to show some source code information provided by
25 plug-ins. 27 plug-ins.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
32 <table> 35
36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td> 39 <td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td>
35 <td>Class implementing a widget to show some source code information provided by plug-ins.</td> 40 <td>Class implementing a widget to show some source code information provided by plug-ins.</td>
36 </tr><tr> 41 </tr>
42 <tr>
37 <td><a href="#DocumentationViewerWidget">DocumentationViewerWidget</a></td> 43 <td><a href="#DocumentationViewerWidget">DocumentationViewerWidget</a></td>
38 <td>Class implementing a rich text documentation viewer.</td> 44 <td>Class implementing a rich text documentation viewer.</td>
39 </tr> 45 </tr>
40 </table> 46 </table>
41 <h3>Functions</h3> 47 <h3>Functions</h3>
42 <table> 48
43 <tr><td>None</td></tr> 49 <table>
44 </table> 50 <tr><td>None</td></tr>
45 <hr /><hr /> 51 </table>
52 <hr />
53 <hr />
46 <a NAME="CodeDocumentationViewer" ID="CodeDocumentationViewer"></a> 54 <a NAME="CodeDocumentationViewer" ID="CodeDocumentationViewer"></a>
47 <h2>CodeDocumentationViewer</h2> 55 <h2>CodeDocumentationViewer</h2>
56
48 <p> 57 <p>
49 Class implementing a widget to show some source code information provided 58 Class implementing a widget to show some source code information provided
50 by plug-ins. 59 by plug-ins.
51 </p><h3>Signals</h3> 60 </p>
52 <dl> 61 <h3>Signals</h3>
62 <dl>
63
53 <dt>providerAdded()</dt> 64 <dt>providerAdded()</dt>
54 <dd> 65 <dd>
55 emitted to indicate the availability of a new 66 emitted to indicate the availability of a new
56 provider 67 provider
57 </dd><dt>providerRemoved()</dt> 68 </dd>
69 <dt>providerRemoved()</dt>
58 <dd> 70 <dd>
59 emitted to indicate the removal of a provider 71 emitted to indicate the removal of a provider
60 </dd> 72 </dd>
61 </dl> 73 </dl>
62 <h3>Derived from</h3> 74 <h3>Derived from</h3>
63 QWidget 75 QWidget
64 <h3>Class Attributes</h3> 76 <h3>Class Attributes</h3>
77
65 <table> 78 <table>
66 <tr><td>None</td></tr> 79 <tr><td>None</td></tr>
67 </table> 80 </table>
68 <h3>Class Methods</h3> 81 <h3>Class Methods</h3>
82
69 <table> 83 <table>
70 <tr><td>None</td></tr> 84 <tr><td>None</td></tr>
71 </table> 85 </table>
72 <h3>Methods</h3> 86 <h3>Methods</h3>
73 <table> 87
88 <table>
89
74 <tr> 90 <tr>
75 <td><a href="#CodeDocumentationViewer.__init__">CodeDocumentationViewer</a></td> 91 <td><a href="#CodeDocumentationViewer.__init__">CodeDocumentationViewer</a></td>
76 <td>Constructor</td> 92 <td>Constructor</td>
77 </tr><tr> 93 </tr>
94 <tr>
78 <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td> 95 <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td>
79 <td>Private method to select a provider programmatically.</td> 96 <td>Private method to select a provider programmatically.</td>
80 </tr><tr> 97 </tr>
98 <tr>
81 <td><a href="#CodeDocumentationViewer.__setupUi">__setupUi</a></td> 99 <td><a href="#CodeDocumentationViewer.__setupUi">__setupUi</a></td>
82 <td>Private method to generate the UI layout.</td> 100 <td>Private method to generate the UI layout.</td>
83 </tr><tr> 101 </tr>
102 <tr>
84 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td> 103 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td>
85 <td>Private method to show a message giving the reason for being disabled.</td> 104 <td>Private method to show a message giving the reason for being disabled.</td>
86 </tr><tr> 105 </tr>
106 <tr>
87 <td><a href="#CodeDocumentationViewer.__unregisterTimerTimeout">__unregisterTimerTimeout</a></td> 107 <td><a href="#CodeDocumentationViewer.__unregisterTimerTimeout">__unregisterTimerTimeout</a></td>
88 <td>Private slot handling the timeout signal of the unregister timer.</td> 108 <td>Private slot handling the timeout signal of the unregister timer.</td>
89 </tr><tr> 109 </tr>
110 <tr>
90 <td><a href="#CodeDocumentationViewer.documentationReady">documentationReady</a></td> 111 <td><a href="#CodeDocumentationViewer.documentationReady">documentationReady</a></td>
91 <td>Public method to provide the documentation info to the viewer.</td> 112 <td>Public method to provide the documentation info to the viewer.</td>
92 </tr><tr> 113 </tr>
114 <tr>
93 <td><a href="#CodeDocumentationViewer.finalizeSetup">finalizeSetup</a></td> 115 <td><a href="#CodeDocumentationViewer.finalizeSetup">finalizeSetup</a></td>
94 <td>Public method to finalize the setup of the documentation viewer.</td> 116 <td>Public method to finalize the setup of the documentation viewer.</td>
95 </tr><tr> 117 </tr>
118 <tr>
96 <td><a href="#CodeDocumentationViewer.getProviders">getProviders</a></td> 119 <td><a href="#CodeDocumentationViewer.getProviders">getProviders</a></td>
97 <td>Public method to get a list of providers and their visible strings.</td> 120 <td>Public method to get a list of providers and their visible strings.</td>
98 </tr><tr> 121 </tr>
122 <tr>
99 <td><a href="#CodeDocumentationViewer.isSupportedLanguage">isSupportedLanguage</a></td> 123 <td><a href="#CodeDocumentationViewer.isSupportedLanguage">isSupportedLanguage</a></td>
100 <td>Public method to check, if the given language is supported by the selected provider.</td> 124 <td>Public method to check, if the given language is supported by the selected provider.</td>
101 </tr><tr> 125 </tr>
126 <tr>
102 <td><a href="#CodeDocumentationViewer.on_providerComboBox_currentIndexChanged">on_providerComboBox_currentIndexChanged</a></td> 127 <td><a href="#CodeDocumentationViewer.on_providerComboBox_currentIndexChanged">on_providerComboBox_currentIndexChanged</a></td>
103 <td>Private slot to handle the selection of a provider.</td> 128 <td>Private slot to handle the selection of a provider.</td>
104 </tr><tr> 129 </tr>
130 <tr>
105 <td><a href="#CodeDocumentationViewer.preferencesChanged">preferencesChanged</a></td> 131 <td><a href="#CodeDocumentationViewer.preferencesChanged">preferencesChanged</a></td>
106 <td>Public slot to handle a change of preferences.</td> 132 <td>Public slot to handle a change of preferences.</td>
107 </tr><tr> 133 </tr>
134 <tr>
108 <td><a href="#CodeDocumentationViewer.registerProvider">registerProvider</a></td> 135 <td><a href="#CodeDocumentationViewer.registerProvider">registerProvider</a></td>
109 <td>Public method register a source docu provider.</td> 136 <td>Public method register a source docu provider.</td>
110 </tr><tr> 137 </tr>
138 <tr>
111 <td><a href="#CodeDocumentationViewer.showInfo">showInfo</a></td> 139 <td><a href="#CodeDocumentationViewer.showInfo">showInfo</a></td>
112 <td>Public method to request code documentation data from a provider.</td> 140 <td>Public method to request code documentation data from a provider.</td>
113 </tr><tr> 141 </tr>
142 <tr>
114 <td><a href="#CodeDocumentationViewer.shutdown">shutdown</a></td> 143 <td><a href="#CodeDocumentationViewer.shutdown">shutdown</a></td>
115 <td>Public method to perform shutdown actions.</td> 144 <td>Public method to perform shutdown actions.</td>
116 </tr><tr> 145 </tr>
146 <tr>
117 <td><a href="#CodeDocumentationViewer.unregisterProvider">unregisterProvider</a></td> 147 <td><a href="#CodeDocumentationViewer.unregisterProvider">unregisterProvider</a></td>
118 <td>Public method register a source docu provider.</td> 148 <td>Public method register a source docu provider.</td>
119 </tr> 149 </tr>
120 </table> 150 </table>
121 <h3>Static Methods</h3> 151 <h3>Static Methods</h3>
122 <table> 152
123 <tr><td>None</td></tr> 153 <table>
124 </table> 154 <tr><td>None</td></tr>
155 </table>
156
125 <a NAME="CodeDocumentationViewer.__init__" ID="CodeDocumentationViewer.__init__"></a> 157 <a NAME="CodeDocumentationViewer.__init__" ID="CodeDocumentationViewer.__init__"></a>
126 <h4>CodeDocumentationViewer (Constructor)</h4> 158 <h4>CodeDocumentationViewer (Constructor)</h4>
127 <b>CodeDocumentationViewer</b>(<i>parent=None</i>) 159 <b>CodeDocumentationViewer</b>(<i>parent=None</i>)
160
128 <p> 161 <p>
129 Constructor 162 Constructor
130 </p><dl> 163 </p>
164 <dl>
165
131 <dt><i>parent</i> (QWidget)</dt> 166 <dt><i>parent</i> (QWidget)</dt>
132 <dd> 167 <dd>
133 reference to the parent widget 168 reference to the parent widget
134 </dd> 169 </dd>
135 </dl><a NAME="CodeDocumentationViewer.__selectProvider" ID="CodeDocumentationViewer.__selectProvider"></a> 170 </dl>
171 <a NAME="CodeDocumentationViewer.__selectProvider" ID="CodeDocumentationViewer.__selectProvider"></a>
136 <h4>CodeDocumentationViewer.__selectProvider</h4> 172 <h4>CodeDocumentationViewer.__selectProvider</h4>
137 <b>__selectProvider</b>(<i>provider</i>) 173 <b>__selectProvider</b>(<i>provider</i>)
174
138 <p> 175 <p>
139 Private method to select a provider programmatically. 176 Private method to select a provider programmatically.
140 </p><dl> 177 </p>
178 <dl>
179
141 <dt><i>provider</i> (str)</dt> 180 <dt><i>provider</i> (str)</dt>
142 <dd> 181 <dd>
143 name of the provider to be selected 182 name of the provider to be selected
144 </dd> 183 </dd>
145 </dl><a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a> 184 </dl>
185 <a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a>
146 <h4>CodeDocumentationViewer.__setupUi</h4> 186 <h4>CodeDocumentationViewer.__setupUi</h4>
147 <b>__setupUi</b>(<i></i>) 187 <b>__setupUi</b>(<i></i>)
188
148 <p> 189 <p>
149 Private method to generate the UI layout. 190 Private method to generate the UI layout.
150 </p><a NAME="CodeDocumentationViewer.__showDisabledMessage" ID="CodeDocumentationViewer.__showDisabledMessage"></a> 191 </p>
192 <a NAME="CodeDocumentationViewer.__showDisabledMessage" ID="CodeDocumentationViewer.__showDisabledMessage"></a>
151 <h4>CodeDocumentationViewer.__showDisabledMessage</h4> 193 <h4>CodeDocumentationViewer.__showDisabledMessage</h4>
152 <b>__showDisabledMessage</b>(<i></i>) 194 <b>__showDisabledMessage</b>(<i></i>)
195
153 <p> 196 <p>
154 Private method to show a message giving the reason for being disabled. 197 Private method to show a message giving the reason for being disabled.
155 </p><a NAME="CodeDocumentationViewer.__unregisterTimerTimeout" ID="CodeDocumentationViewer.__unregisterTimerTimeout"></a> 198 </p>
199 <a NAME="CodeDocumentationViewer.__unregisterTimerTimeout" ID="CodeDocumentationViewer.__unregisterTimerTimeout"></a>
156 <h4>CodeDocumentationViewer.__unregisterTimerTimeout</h4> 200 <h4>CodeDocumentationViewer.__unregisterTimerTimeout</h4>
157 <b>__unregisterTimerTimeout</b>(<i></i>) 201 <b>__unregisterTimerTimeout</b>(<i></i>)
202
158 <p> 203 <p>
159 Private slot handling the timeout signal of the unregister timer. 204 Private slot handling the timeout signal of the unregister timer.
160 </p><a NAME="CodeDocumentationViewer.documentationReady" ID="CodeDocumentationViewer.documentationReady"></a> 205 </p>
206 <a NAME="CodeDocumentationViewer.documentationReady" ID="CodeDocumentationViewer.documentationReady"></a>
161 <h4>CodeDocumentationViewer.documentationReady</h4> 207 <h4>CodeDocumentationViewer.documentationReady</h4>
162 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>) 208 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>)
209
163 <p> 210 <p>
164 Public method to provide the documentation info to the viewer. 211 Public method to provide the documentation info to the viewer.
165 </p><p> 212 </p>
213 <p>
166 If documentationInfo is a dictionary, it should contain these 214 If documentationInfo is a dictionary, it should contain these
167 (optional) keys and data: 215 (optional) keys and data:
168 </p><p> 216 </p>
217 <p>
169 name: the name of the inspected object 218 name: the name of the inspected object
170 argspec: its arguments specification 219 argspec: its arguments specification
171 note: A phrase describing the type of object (function or method) and 220 note: A phrase describing the type of object (function or method) and
172 the module it belongs to. 221 the module it belongs to.
173 docstring: its documentation string 222 docstring: its documentation string
174 typ: its type information 223 typ: its type information
175 </p><dl> 224 </p>
225 <dl>
226
176 <dt><i>documentationInfo</i> (dict or str)</dt> 227 <dt><i>documentationInfo</i> (dict or str)</dt>
177 <dd> 228 <dd>
178 dictionary containing the source docu data 229 dictionary containing the source docu data
179 </dd><dt><i>isWarning</i> (bool)</dt> 230 </dd>
231 <dt><i>isWarning</i> (bool)</dt>
180 <dd> 232 <dd>
181 flag indicating a warning page 233 flag indicating a warning page
182 </dd><dt><i>isDocWarning</i> (bool)</dt> 234 </dd>
235 <dt><i>isDocWarning</i> (bool)</dt>
183 <dd> 236 <dd>
184 flag indicating a documentation warning page 237 flag indicating a documentation warning page
185 </dd> 238 </dd>
186 </dl><a NAME="CodeDocumentationViewer.finalizeSetup" ID="CodeDocumentationViewer.finalizeSetup"></a> 239 </dl>
240 <a NAME="CodeDocumentationViewer.finalizeSetup" ID="CodeDocumentationViewer.finalizeSetup"></a>
187 <h4>CodeDocumentationViewer.finalizeSetup</h4> 241 <h4>CodeDocumentationViewer.finalizeSetup</h4>
188 <b>finalizeSetup</b>(<i></i>) 242 <b>finalizeSetup</b>(<i></i>)
243
189 <p> 244 <p>
190 Public method to finalize the setup of the documentation viewer. 245 Public method to finalize the setup of the documentation viewer.
191 </p><a NAME="CodeDocumentationViewer.getProviders" ID="CodeDocumentationViewer.getProviders"></a> 246 </p>
247 <a NAME="CodeDocumentationViewer.getProviders" ID="CodeDocumentationViewer.getProviders"></a>
192 <h4>CodeDocumentationViewer.getProviders</h4> 248 <h4>CodeDocumentationViewer.getProviders</h4>
193 <b>getProviders</b>(<i></i>) 249 <b>getProviders</b>(<i></i>)
250
194 <p> 251 <p>
195 Public method to get a list of providers and their visible strings. 252 Public method to get a list of providers and their visible strings.
196 </p><dl> 253 </p>
254 <dl>
197 <dt>Returns:</dt> 255 <dt>Returns:</dt>
198 <dd> 256 <dd>
199 list containing the providers and their visible strings 257 list containing the providers and their visible strings
200 </dd> 258 </dd>
201 </dl><dl> 259 </dl>
260 <dl>
202 <dt>Return Type:</dt> 261 <dt>Return Type:</dt>
203 <dd> 262 <dd>
204 list of tuple of (str,str) 263 list of tuple of (str,str)
205 </dd> 264 </dd>
206 </dl><a NAME="CodeDocumentationViewer.isSupportedLanguage" ID="CodeDocumentationViewer.isSupportedLanguage"></a> 265 </dl>
266 <a NAME="CodeDocumentationViewer.isSupportedLanguage" ID="CodeDocumentationViewer.isSupportedLanguage"></a>
207 <h4>CodeDocumentationViewer.isSupportedLanguage</h4> 267 <h4>CodeDocumentationViewer.isSupportedLanguage</h4>
208 <b>isSupportedLanguage</b>(<i>language</i>) 268 <b>isSupportedLanguage</b>(<i>language</i>)
269
209 <p> 270 <p>
210 Public method to check, if the given language is supported by the 271 Public method to check, if the given language is supported by the
211 selected provider. 272 selected provider.
212 </p><dl> 273 </p>
274 <dl>
275
213 <dt><i>language</i> (str)</dt> 276 <dt><i>language</i> (str)</dt>
214 <dd> 277 <dd>
215 editor programming language to check 278 editor programming language to check
216 </dd> 279 </dd>
217 </dl><dl> 280 </dl>
281 <dl>
218 <dt>Returns:</dt> 282 <dt>Returns:</dt>
219 <dd> 283 <dd>
220 flag indicating the support status 284 flag indicating the support status
221 </dd> 285 </dd>
222 </dl><dl> 286 </dl>
287 <dl>
223 <dt>Return Type:</dt> 288 <dt>Return Type:</dt>
224 <dd> 289 <dd>
225 bool 290 bool
226 </dd> 291 </dd>
227 </dl><a NAME="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged" ID="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged"></a> 292 </dl>
293 <a NAME="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged" ID="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged"></a>
228 <h4>CodeDocumentationViewer.on_providerComboBox_currentIndexChanged</h4> 294 <h4>CodeDocumentationViewer.on_providerComboBox_currentIndexChanged</h4>
229 <b>on_providerComboBox_currentIndexChanged</b>(<i>index</i>) 295 <b>on_providerComboBox_currentIndexChanged</b>(<i>index</i>)
296
230 <p> 297 <p>
231 Private slot to handle the selection of a provider. 298 Private slot to handle the selection of a provider.
232 </p><dl> 299 </p>
300 <dl>
301
233 <dt><i>index</i> (int)</dt> 302 <dt><i>index</i> (int)</dt>
234 <dd> 303 <dd>
235 index of the selected provider 304 index of the selected provider
236 </dd> 305 </dd>
237 </dl><a NAME="CodeDocumentationViewer.preferencesChanged" ID="CodeDocumentationViewer.preferencesChanged"></a> 306 </dl>
307 <a NAME="CodeDocumentationViewer.preferencesChanged" ID="CodeDocumentationViewer.preferencesChanged"></a>
238 <h4>CodeDocumentationViewer.preferencesChanged</h4> 308 <h4>CodeDocumentationViewer.preferencesChanged</h4>
239 <b>preferencesChanged</b>(<i></i>) 309 <b>preferencesChanged</b>(<i></i>)
310
240 <p> 311 <p>
241 Public slot to handle a change of preferences. 312 Public slot to handle a change of preferences.
242 </p><a NAME="CodeDocumentationViewer.registerProvider" ID="CodeDocumentationViewer.registerProvider"></a> 313 </p>
314 <a NAME="CodeDocumentationViewer.registerProvider" ID="CodeDocumentationViewer.registerProvider"></a>
243 <h4>CodeDocumentationViewer.registerProvider</h4> 315 <h4>CodeDocumentationViewer.registerProvider</h4>
244 <b>registerProvider</b>(<i>providerName, providerDisplay, provider, supported</i>) 316 <b>registerProvider</b>(<i>providerName, providerDisplay, provider, supported</i>)
317
245 <p> 318 <p>
246 Public method register a source docu provider. 319 Public method register a source docu provider.
247 </p><dl> 320 </p>
321 <dl>
322
248 <dt><i>providerName</i> (str)</dt> 323 <dt><i>providerName</i> (str)</dt>
249 <dd> 324 <dd>
250 name of the provider (must be unique) 325 name of the provider (must be unique)
251 </dd><dt><i>providerDisplay</i> (str)</dt> 326 </dd>
327 <dt><i>providerDisplay</i> (str)</dt>
252 <dd> 328 <dd>
253 visible name of the provider 329 visible name of the provider
254 </dd><dt><i>provider</i> (function(editor))</dt> 330 </dd>
331 <dt><i>provider</i> (function(editor))</dt>
255 <dd> 332 <dd>
256 function to be called to determine source docu 333 function to be called to determine source docu
257 </dd><dt><i>supported</i> (function(language))</dt> 334 </dd>
335 <dt><i>supported</i> (function(language))</dt>
258 <dd> 336 <dd>
259 function to be called to determine, if a language is 337 function to be called to determine, if a language is
260 supported 338 supported
261 </dd> 339 </dd>
262 </dl><dl> 340 </dl>
341 <dl>
342
263 <dt>Raises <b>KeyError</b>:</dt> 343 <dt>Raises <b>KeyError</b>:</dt>
264 <dd> 344 <dd>
265 raised if a provider with the given name was 345 raised if a provider with the given name was
266 already registered 346 already registered
267 </dd> 347 </dd>
268 </dl><a NAME="CodeDocumentationViewer.showInfo" ID="CodeDocumentationViewer.showInfo"></a> 348 </dl>
349 <a NAME="CodeDocumentationViewer.showInfo" ID="CodeDocumentationViewer.showInfo"></a>
269 <h4>CodeDocumentationViewer.showInfo</h4> 350 <h4>CodeDocumentationViewer.showInfo</h4>
270 <b>showInfo</b>(<i>editor</i>) 351 <b>showInfo</b>(<i>editor</i>)
352
271 <p> 353 <p>
272 Public method to request code documentation data from a provider. 354 Public method to request code documentation data from a provider.
273 </p><dl> 355 </p>
356 <dl>
357
274 <dt><i>editor</i> (Editor)</dt> 358 <dt><i>editor</i> (Editor)</dt>
275 <dd> 359 <dd>
276 reference to the editor to request code docu for 360 reference to the editor to request code docu for
277 </dd> 361 </dd>
278 </dl><a NAME="CodeDocumentationViewer.shutdown" ID="CodeDocumentationViewer.shutdown"></a> 362 </dl>
363 <a NAME="CodeDocumentationViewer.shutdown" ID="CodeDocumentationViewer.shutdown"></a>
279 <h4>CodeDocumentationViewer.shutdown</h4> 364 <h4>CodeDocumentationViewer.shutdown</h4>
280 <b>shutdown</b>(<i></i>) 365 <b>shutdown</b>(<i></i>)
366
281 <p> 367 <p>
282 Public method to perform shutdown actions. 368 Public method to perform shutdown actions.
283 </p><a NAME="CodeDocumentationViewer.unregisterProvider" ID="CodeDocumentationViewer.unregisterProvider"></a> 369 </p>
370 <a NAME="CodeDocumentationViewer.unregisterProvider" ID="CodeDocumentationViewer.unregisterProvider"></a>
284 <h4>CodeDocumentationViewer.unregisterProvider</h4> 371 <h4>CodeDocumentationViewer.unregisterProvider</h4>
285 <b>unregisterProvider</b>(<i>providerName</i>) 372 <b>unregisterProvider</b>(<i>providerName</i>)
373
286 <p> 374 <p>
287 Public method register a source docu provider. 375 Public method register a source docu provider.
288 </p><dl> 376 </p>
377 <dl>
378
289 <dt><i>providerName</i> (str)</dt> 379 <dt><i>providerName</i> (str)</dt>
290 <dd> 380 <dd>
291 name of the provider (must be unique) 381 name of the provider (must be unique)
292 </dd> 382 </dd>
293 </dl> 383 </dl>
294 <div align="right"><a href="#top">Up</a></div> 384 <div align="right"><a href="#top">Up</a></div>
295 <hr /><hr /> 385 <hr />
386 <hr />
296 <a NAME="DocumentationViewerWidget" ID="DocumentationViewerWidget"></a> 387 <a NAME="DocumentationViewerWidget" ID="DocumentationViewerWidget"></a>
297 <h2>DocumentationViewerWidget</h2> 388 <h2>DocumentationViewerWidget</h2>
389
298 <p> 390 <p>
299 Class implementing a rich text documentation viewer. 391 Class implementing a rich text documentation viewer.
300 </p> 392 </p>
301 <h3>Derived from</h3> 393 <h3>Derived from</h3>
302 QWidget 394 QWidget
303 <h3>Class Attributes</h3> 395 <h3>Class Attributes</h3>
396
304 <table> 397 <table>
305 <tr><td>None</td></tr> 398 <tr><td>None</td></tr>
306 </table> 399 </table>
307 <h3>Class Methods</h3> 400 <h3>Class Methods</h3>
401
308 <table> 402 <table>
309 <tr><td>None</td></tr> 403 <tr><td>None</td></tr>
310 </table> 404 </table>
311 <h3>Methods</h3> 405 <h3>Methods</h3>
312 <table> 406
407 <table>
408
313 <tr> 409 <tr>
314 <td><a href="#DocumentationViewerWidget.__init__">DocumentationViewerWidget</a></td> 410 <td><a href="#DocumentationViewerWidget.__init__">DocumentationViewerWidget</a></td>
315 <td>Constructor</td> 411 <td>Constructor</td>
316 </tr><tr> 412 </tr>
413 <tr>
317 <td><a href="#DocumentationViewerWidget.__showLink">__showLink</a></td> 414 <td><a href="#DocumentationViewerWidget.__showLink">__showLink</a></td>
318 <td>Private slot to show the hovered link in a tooltip.</td> 415 <td>Private slot to show the hovered link in a tooltip.</td>
319 </tr><tr> 416 </tr>
417 <tr>
320 <td><a href="#DocumentationViewerWidget.clear">clear</a></td> 418 <td><a href="#DocumentationViewerWidget.clear">clear</a></td>
321 <td>Public method to clear the shown contents.</td> 419 <td>Public method to clear the shown contents.</td>
322 </tr><tr> 420 </tr>
421 <tr>
323 <td><a href="#DocumentationViewerWidget.setHtml">setHtml</a></td> 422 <td><a href="#DocumentationViewerWidget.setHtml">setHtml</a></td>
324 <td>Public method to set the HTML text of the widget.</td> 423 <td>Public method to set the HTML text of the widget.</td>
325 </tr> 424 </tr>
326 </table> 425 </table>
327 <h3>Static Methods</h3> 426 <h3>Static Methods</h3>
328 <table> 427
329 <tr><td>None</td></tr> 428 <table>
330 </table> 429 <tr><td>None</td></tr>
430 </table>
431
331 <a NAME="DocumentationViewerWidget.__init__" ID="DocumentationViewerWidget.__init__"></a> 432 <a NAME="DocumentationViewerWidget.__init__" ID="DocumentationViewerWidget.__init__"></a>
332 <h4>DocumentationViewerWidget (Constructor)</h4> 433 <h4>DocumentationViewerWidget (Constructor)</h4>
333 <b>DocumentationViewerWidget</b>(<i>parent=None</i>) 434 <b>DocumentationViewerWidget</b>(<i>parent=None</i>)
435
334 <p> 436 <p>
335 Constructor 437 Constructor
336 </p><dl> 438 </p>
439 <dl>
440
337 <dt><i>parent</i> (QWidget)</dt> 441 <dt><i>parent</i> (QWidget)</dt>
338 <dd> 442 <dd>
339 reference to the parent widget 443 reference to the parent widget
340 </dd> 444 </dd>
341 </dl><a NAME="DocumentationViewerWidget.__showLink" ID="DocumentationViewerWidget.__showLink"></a> 445 </dl>
446 <a NAME="DocumentationViewerWidget.__showLink" ID="DocumentationViewerWidget.__showLink"></a>
342 <h4>DocumentationViewerWidget.__showLink</h4> 447 <h4>DocumentationViewerWidget.__showLink</h4>
343 <b>__showLink</b>(<i>urlStr</i>) 448 <b>__showLink</b>(<i>urlStr</i>)
449
344 <p> 450 <p>
345 Private slot to show the hovered link in a tooltip. 451 Private slot to show the hovered link in a tooltip.
346 </p><dl> 452 </p>
453 <dl>
454
347 <dt><i>urlStr</i> (str)</dt> 455 <dt><i>urlStr</i> (str)</dt>
348 <dd> 456 <dd>
349 hovered URL 457 hovered URL
350 </dd> 458 </dd>
351 </dl><a NAME="DocumentationViewerWidget.clear" ID="DocumentationViewerWidget.clear"></a> 459 </dl>
460 <a NAME="DocumentationViewerWidget.clear" ID="DocumentationViewerWidget.clear"></a>
352 <h4>DocumentationViewerWidget.clear</h4> 461 <h4>DocumentationViewerWidget.clear</h4>
353 <b>clear</b>(<i></i>) 462 <b>clear</b>(<i></i>)
463
354 <p> 464 <p>
355 Public method to clear the shown contents. 465 Public method to clear the shown contents.
356 </p><a NAME="DocumentationViewerWidget.setHtml" ID="DocumentationViewerWidget.setHtml"></a> 466 </p>
467 <a NAME="DocumentationViewerWidget.setHtml" ID="DocumentationViewerWidget.setHtml"></a>
357 <h4>DocumentationViewerWidget.setHtml</h4> 468 <h4>DocumentationViewerWidget.setHtml</h4>
358 <b>setHtml</b>(<i>html</i>) 469 <b>setHtml</b>(<i>html</i>)
470
359 <p> 471 <p>
360 Public method to set the HTML text of the widget. 472 Public method to set the HTML text of the widget.
361 </p><dl> 473 </p>
474 <dl>
475
362 <dt><i>html</i> (str)</dt> 476 <dt><i>html</i> (str)</dt>
363 <dd> 477 <dd>
364 HTML text to be shown 478 HTML text to be shown
365 </dd> 479 </dd>
366 </dl> 480 </dl>

Mercurial Repository: eric

eric ide

mercurial