76 <table> |
76 <table> |
77 <tr> |
77 <tr> |
78 <td><a href="#CodeDocumentationViewer.__init__">CodeDocumentationViewer</a></td> |
78 <td><a href="#CodeDocumentationViewer.__init__">CodeDocumentationViewer</a></td> |
79 <td>Constructor</td> |
79 <td>Constructor</td> |
80 </tr><tr> |
80 </tr><tr> |
|
81 <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td> |
|
82 <td>Private method to select a provider programmatically.</td> |
|
83 </tr><tr> |
81 <td><a href="#CodeDocumentationViewer.__setHtml">__setHtml</a></td> |
84 <td><a href="#CodeDocumentationViewer.__setHtml">__setHtml</a></td> |
82 <td>Private slot to set the prepared HTML text.</td> |
85 <td>Private slot to set the prepared HTML text.</td> |
83 </tr><tr> |
86 </tr><tr> |
84 <td><a href="#CodeDocumentationViewer.__setHtmlWarning">__setHtmlWarning</a></td> |
87 <td><a href="#CodeDocumentationViewer.__setHtmlWarning">__setHtmlWarning</a></td> |
85 <td>Private slot to set a display message.</td> |
88 <td>Private slot to set a display message.</td> |
90 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td> |
93 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td> |
91 <td>Private method to show a message giving the reason for being disabled.</td> |
94 <td>Private method to show a message giving the reason for being disabled.</td> |
92 </tr><tr> |
95 </tr><tr> |
93 <td><a href="#CodeDocumentationViewer.__showTextViewer">__showTextViewer</a></td> |
96 <td><a href="#CodeDocumentationViewer.__showTextViewer">__showTextViewer</a></td> |
94 <td>Private slot to show the selected viewer.</td> |
97 <td>Private slot to show the selected viewer.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#CodeDocumentationViewer.__unregisterTimerTimeout">__unregisterTimerTimeout</a></td> |
|
100 <td>Private slot handling the timeout signal of the unregister timer.</td> |
95 </tr><tr> |
101 </tr><tr> |
96 <td><a href="#CodeDocumentationViewer.documentationReady">documentationReady</a></td> |
102 <td><a href="#CodeDocumentationViewer.documentationReady">documentationReady</a></td> |
97 <td>Public method to provide the documentation info to the viewer.</td> |
103 <td>Public method to provide the documentation info to the viewer.</td> |
98 </tr><tr> |
104 </tr><tr> |
99 <td><a href="#CodeDocumentationViewer.finalizeSetup">finalizeSetup</a></td> |
105 <td><a href="#CodeDocumentationViewer.finalizeSetup">finalizeSetup</a></td> |
135 Constructor |
141 Constructor |
136 </p><dl> |
142 </p><dl> |
137 <dt><i>parent</i> (QWidget)</dt> |
143 <dt><i>parent</i> (QWidget)</dt> |
138 <dd> |
144 <dd> |
139 reference to the parent widget |
145 reference to the parent widget |
|
146 </dd> |
|
147 </dl><a NAME="CodeDocumentationViewer.__selectProvider" ID="CodeDocumentationViewer.__selectProvider"></a> |
|
148 <h4>CodeDocumentationViewer.__selectProvider</h4> |
|
149 <b>__selectProvider</b>(<i>provider</i>) |
|
150 <p> |
|
151 Private method to select a provider programmatically. |
|
152 </p><dl> |
|
153 <dt><i>provider</i> (str)</dt> |
|
154 <dd> |
|
155 name of the provider to be selected |
140 </dd> |
156 </dd> |
141 </dl><a NAME="CodeDocumentationViewer.__setHtml" ID="CodeDocumentationViewer.__setHtml"></a> |
157 </dl><a NAME="CodeDocumentationViewer.__setHtml" ID="CodeDocumentationViewer.__setHtml"></a> |
142 <h4>CodeDocumentationViewer.__setHtml</h4> |
158 <h4>CodeDocumentationViewer.__setHtml</h4> |
143 <b>__setHtml</b>(<i>html</i>) |
159 <b>__setHtml</b>(<i>html</i>) |
144 <p> |
160 <p> |
176 </p><dl> |
192 </p><dl> |
177 <dt><i>richText</i> (bool)</dt> |
193 <dt><i>richText</i> (bool)</dt> |
178 <dd> |
194 <dd> |
179 flag indicating the rich text viewer |
195 flag indicating the rich text viewer |
180 </dd> |
196 </dd> |
181 </dl><a NAME="CodeDocumentationViewer.documentationReady" ID="CodeDocumentationViewer.documentationReady"></a> |
197 </dl><a NAME="CodeDocumentationViewer.__unregisterTimerTimeout" ID="CodeDocumentationViewer.__unregisterTimerTimeout"></a> |
|
198 <h4>CodeDocumentationViewer.__unregisterTimerTimeout</h4> |
|
199 <b>__unregisterTimerTimeout</b>(<i></i>) |
|
200 <p> |
|
201 Private slot handling the timeout signal of the unregister timer. |
|
202 </p><a NAME="CodeDocumentationViewer.documentationReady" ID="CodeDocumentationViewer.documentationReady"></a> |
182 <h4>CodeDocumentationViewer.documentationReady</h4> |
203 <h4>CodeDocumentationViewer.documentationReady</h4> |
183 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>) |
204 <b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>) |
184 <p> |
205 <p> |
185 Public method to provide the documentation info to the viewer. |
206 Public method to provide the documentation info to the viewer. |
186 </p><p> |
207 </p><p> |