Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.Previewer.html
src/eric7/Documentation/Source/eric7.UI.Previewer.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.Previewer</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.UI.Previewer</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a previewer widget for HTML, Markdown and ReST files. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Previewer">Previewer</a></td> | |
| 25 <td>Class implementing a previewer widget containing a stack of specialized previewers.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="Previewer" ID="Previewer"></a> | |
| 36 <h2>Previewer</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a previewer widget containing a stack of | |
| 40 specialized previewers. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 QStackedWidget | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>None</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#Previewer.__init__">Previewer</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#Previewer.__editorChanged">__editorChanged</a></td> | |
| 64 <td>Private slot to handle a change of the current editor.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#Previewer.__editorLanguageChanged">__editorLanguageChanged</a></td> | |
| 68 <td>Private slot to handle a change of the current editor's language.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#Previewer.__editorTextChanged">__editorTextChanged</a></td> | |
| 72 <td>Private slot to handle changes of an editor's text.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#Previewer.__isPreviewable">__isPreviewable</a></td> | |
| 76 <td>Private method to check, if a preview can be shown for the given editor.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#Previewer.__previewStateChanged">__previewStateChanged</a></td> | |
| 80 <td>Private slot to toggle the display of the preview.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#Previewer.__processEditor">__processEditor</a></td> | |
| 84 <td>Private slot to schedule the processing of the current editor's text.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#Previewer.__splitterMoved">__splitterMoved</a></td> | |
| 88 <td>Private slot to handle the movement of the embedding splitter's handle.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#Previewer.hide">hide</a></td> | |
| 92 <td>Public method to hide the preview widget.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#Previewer.preferencesChanged">preferencesChanged</a></td> | |
| 96 <td>Public slot handling a change of preferences.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#Previewer.setSplitter">setSplitter</a></td> | |
| 100 <td>Public method to set the splitter.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#Previewer.show">show</a></td> | |
| 104 <td>Public method to show the preview widget.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#Previewer.shutdown">shutdown</a></td> | |
| 108 <td>Public method to perform shutdown actions.</td> | |
| 109 </tr> | |
| 110 </table> | |
| 111 <h3>Static Methods</h3> | |
| 112 | |
| 113 <table> | |
| 114 <tr><td>None</td></tr> | |
| 115 </table> | |
| 116 | |
| 117 <a NAME="Previewer.__init__" ID="Previewer.__init__"></a> | |
| 118 <h4>Previewer (Constructor)</h4> | |
| 119 <b>Previewer</b>(<i>viewmanager, parent=None</i>) | |
| 120 | |
| 121 <p> | |
| 122 Constructor | |
| 123 </p> | |
| 124 <dl> | |
| 125 | |
| 126 <dt><i>viewmanager</i> (ViewManager)</dt> | |
| 127 <dd> | |
| 128 reference to the viewmanager object | |
| 129 </dd> | |
| 130 <dt><i>parent</i> (QWidget)</dt> | |
| 131 <dd> | |
| 132 reference to the parent widget | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a> | |
| 136 <h4>Previewer.__editorChanged</h4> | |
| 137 <b>__editorChanged</b>(<i>editor</i>) | |
| 138 | |
| 139 <p> | |
| 140 Private slot to handle a change of the current editor. | |
| 141 </p> | |
| 142 <dl> | |
| 143 | |
| 144 <dt><i>editor</i> (Editor)</dt> | |
| 145 <dd> | |
| 146 reference to the editor | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a> | |
| 150 <h4>Previewer.__editorLanguageChanged</h4> | |
| 151 <b>__editorLanguageChanged</b>(<i>editor</i>) | |
| 152 | |
| 153 <p> | |
| 154 Private slot to handle a change of the current editor's language. | |
| 155 </p> | |
| 156 <dl> | |
| 157 | |
| 158 <dt><i>editor</i> (Editor)</dt> | |
| 159 <dd> | |
| 160 reference to the editor | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a> | |
| 164 <h4>Previewer.__editorTextChanged</h4> | |
| 165 <b>__editorTextChanged</b>(<i>editor</i>) | |
| 166 | |
| 167 <p> | |
| 168 Private slot to handle changes of an editor's text. | |
| 169 </p> | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>editor</i> (Editor)</dt> | |
| 173 <dd> | |
| 174 reference to the editor | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a> | |
| 178 <h4>Previewer.__isPreviewable</h4> | |
| 179 <b>__isPreviewable</b>(<i>editor</i>) | |
| 180 | |
| 181 <p> | |
| 182 Private method to check, if a preview can be shown for the given | |
| 183 editor. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>editor</i> (Editor)</dt> | |
| 188 <dd> | |
| 189 reference to an editor | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <dl> | |
| 193 <dt>Return:</dt> | |
| 194 <dd> | |
| 195 flag indicating if a preview can be shown | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <dl> | |
| 199 <dt>Return Type:</dt> | |
| 200 <dd> | |
| 201 bool | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a> | |
| 205 <h4>Previewer.__previewStateChanged</h4> | |
| 206 <b>__previewStateChanged</b>(<i>on</i>) | |
| 207 | |
| 208 <p> | |
| 209 Private slot to toggle the display of the preview. | |
| 210 </p> | |
| 211 <dl> | |
| 212 | |
| 213 <dt><i>on</i> (bool)</dt> | |
| 214 <dd> | |
| 215 flag indicating to show a preview | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a> | |
| 219 <h4>Previewer.__processEditor</h4> | |
| 220 <b>__processEditor</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Private slot to schedule the processing of the current editor's text. | |
| 224 </p> | |
| 225 <a NAME="Previewer.__splitterMoved" ID="Previewer.__splitterMoved"></a> | |
| 226 <h4>Previewer.__splitterMoved</h4> | |
| 227 <b>__splitterMoved</b>(<i></i>) | |
| 228 | |
| 229 <p> | |
| 230 Private slot to handle the movement of the embedding splitter's handle. | |
| 231 </p> | |
| 232 <a NAME="Previewer.hide" ID="Previewer.hide"></a> | |
| 233 <h4>Previewer.hide</h4> | |
| 234 <b>hide</b>(<i></i>) | |
| 235 | |
| 236 <p> | |
| 237 Public method to hide the preview widget. | |
| 238 </p> | |
| 239 <a NAME="Previewer.preferencesChanged" ID="Previewer.preferencesChanged"></a> | |
| 240 <h4>Previewer.preferencesChanged</h4> | |
| 241 <b>preferencesChanged</b>(<i></i>) | |
| 242 | |
| 243 <p> | |
| 244 Public slot handling a change of preferences. | |
| 245 </p> | |
| 246 <a NAME="Previewer.setSplitter" ID="Previewer.setSplitter"></a> | |
| 247 <h4>Previewer.setSplitter</h4> | |
| 248 <b>setSplitter</b>(<i>splitter</i>) | |
| 249 | |
| 250 <p> | |
| 251 Public method to set the splitter. | |
| 252 </p> | |
| 253 <dl> | |
| 254 | |
| 255 <dt><i>splitter</i> (QSplitter)</dt> | |
| 256 <dd> | |
| 257 reference to the embedding splitter | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <a NAME="Previewer.show" ID="Previewer.show"></a> | |
| 261 <h4>Previewer.show</h4> | |
| 262 <b>show</b>(<i></i>) | |
| 263 | |
| 264 <p> | |
| 265 Public method to show the preview widget. | |
| 266 </p> | |
| 267 <a NAME="Previewer.shutdown" ID="Previewer.shutdown"></a> | |
| 268 <h4>Previewer.shutdown</h4> | |
| 269 <b>shutdown</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Public method to perform shutdown actions. | |
| 273 </p> | |
| 274 <div align="right"><a href="#top">Up</a></div> | |
| 275 <hr /> | |
| 276 </body></html> |
