Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.EditorAssembly.html
src/eric7/Documentation/Source/eric7.QScintilla.EditorAssembly.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9687
- 3a240d3f3b8c
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.EditorAssembly</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.QScintilla.EditorAssembly</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the editor assembly widget containing the navigation | |
| 13 combos and the editor widget. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#EditorAssembly">EditorAssembly</a></td> | |
| 26 <td>Class implementing the editor assembly widget containing the navigation combos and the editor widget.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="EditorAssembly" ID="EditorAssembly"></a> | |
| 37 <h2>EditorAssembly</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing the editor assembly widget containing the navigation | |
| 41 combos and the editor widget. | |
| 42 </p> | |
| 43 <h3>Derived from</h3> | |
| 44 QWidget | |
| 45 <h3>Class Attributes</h3> | |
| 46 | |
| 47 <table> | |
| 48 <tr><td>None</td></tr> | |
| 49 </table> | |
| 50 <h3>Class Methods</h3> | |
| 51 | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 | |
| 57 <table> | |
| 58 | |
| 59 <tr> | |
| 60 <td><a href="#EditorAssembly.__init__">EditorAssembly</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#EditorAssembly.__activateCombos">__activateCombos</a></td> | |
| 65 <td>Private slot to activate the navigation combo boxes.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#EditorAssembly.__activateOutline">__activateOutline</a></td> | |
| 69 <td>Private slot to activate the source outline view.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#EditorAssembly.__editorChanged">__editorChanged</a></td> | |
| 73 <td>Private slot handling changes of the editor language or file name.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#EditorAssembly.__editorCursorLineChanged">__editorCursorLineChanged</a></td> | |
| 77 <td>Private slot handling a line change of the cursor of the editor.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#EditorAssembly.__globalsActivated">__globalsActivated</a></td> | |
| 81 <td>Private method to jump to the line of the selected global entry and to populate the members combo box.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#EditorAssembly.__membersActivated">__membersActivated</a></td> | |
| 85 <td>Private method to jump to the line of the selected members entry.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#EditorAssembly.__parseEditor">__parseEditor</a></td> | |
| 89 <td>Private method to parse the editor source and repopulate the globals combo.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#EditorAssembly.__preferencesChanged">__preferencesChanged</a></td> | |
| 93 <td>Private slot handling a change of preferences.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#EditorAssembly.__resetParseTimer">__resetParseTimer</a></td> | |
| 97 <td>Private slot to reset the parse timer.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#EditorAssembly.getEditor">getEditor</a></td> | |
| 101 <td>Public method to get the reference to the editor widget.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#EditorAssembly.shutdownTimer">shutdownTimer</a></td> | |
| 105 <td>Public method to stop and disconnect the timer.</td> | |
| 106 </tr> | |
| 107 </table> | |
| 108 <h3>Static Methods</h3> | |
| 109 | |
| 110 <table> | |
| 111 <tr><td>None</td></tr> | |
| 112 </table> | |
| 113 | |
| 114 <a NAME="EditorAssembly.__init__" ID="EditorAssembly.__init__"></a> | |
| 115 <h4>EditorAssembly (Constructor)</h4> | |
| 116 <b>EditorAssembly</b>(<i>dbs, fn="", vm=None, filetype="", editor=None, tv=None</i>) | |
| 117 | |
| 118 <p> | |
| 119 Constructor | |
| 120 </p> | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>dbs</i> (DebugServer)</dt> | |
| 124 <dd> | |
| 125 reference to the debug server object | |
| 126 </dd> | |
| 127 <dt><i>fn</i> (str)</dt> | |
| 128 <dd> | |
| 129 name of the file to be opened. If it is None, | |
| 130 a new (empty) editor is opened. | |
| 131 </dd> | |
| 132 <dt><i>vm</i> (ViewManager.ViewManager)</dt> | |
| 133 <dd> | |
| 134 reference to the view manager object | |
| 135 </dd> | |
| 136 <dt><i>filetype</i> (str)</dt> | |
| 137 <dd> | |
| 138 type of the source file | |
| 139 </dd> | |
| 140 <dt><i>editor</i> (Editor)</dt> | |
| 141 <dd> | |
| 142 reference to an Editor object, if this is a cloned view | |
| 143 </dd> | |
| 144 <dt><i>tv</i> (TaskViewer)</dt> | |
| 145 <dd> | |
| 146 reference to the task viewer object | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="EditorAssembly.__activateCombos" ID="EditorAssembly.__activateCombos"></a> | |
| 150 <h4>EditorAssembly.__activateCombos</h4> | |
| 151 <b>__activateCombos</b>(<i>activate</i>) | |
| 152 | |
| 153 <p> | |
| 154 Private slot to activate the navigation combo boxes. | |
| 155 </p> | |
| 156 <dl> | |
| 157 | |
| 158 <dt><i>activate</i> (bool)</dt> | |
| 159 <dd> | |
| 160 flag indicating to activate the combo boxes | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <a NAME="EditorAssembly.__activateOutline" ID="EditorAssembly.__activateOutline"></a> | |
| 164 <h4>EditorAssembly.__activateOutline</h4> | |
| 165 <b>__activateOutline</b>(<i>activate</i>) | |
| 166 | |
| 167 <p> | |
| 168 Private slot to activate the source outline view. | |
| 169 </p> | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>activate</i> (bool)</dt> | |
| 173 <dd> | |
| 174 flag indicating to activate the source outline view | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <a NAME="EditorAssembly.__editorChanged" ID="EditorAssembly.__editorChanged"></a> | |
| 178 <h4>EditorAssembly.__editorChanged</h4> | |
| 179 <b>__editorChanged</b>(<i></i>) | |
| 180 | |
| 181 <p> | |
| 182 Private slot handling changes of the editor language or file name. | |
| 183 </p> | |
| 184 <a NAME="EditorAssembly.__editorCursorLineChanged" ID="EditorAssembly.__editorCursorLineChanged"></a> | |
| 185 <h4>EditorAssembly.__editorCursorLineChanged</h4> | |
| 186 <b>__editorCursorLineChanged</b>(<i>lineno</i>) | |
| 187 | |
| 188 <p> | |
| 189 Private slot handling a line change of the cursor of the editor. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>lineno</i> (int)</dt> | |
| 194 <dd> | |
| 195 line number of the cursor | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="EditorAssembly.__globalsActivated" ID="EditorAssembly.__globalsActivated"></a> | |
| 199 <h4>EditorAssembly.__globalsActivated</h4> | |
| 200 <b>__globalsActivated</b>(<i>index, moveCursor=True</i>) | |
| 201 | |
| 202 <p> | |
| 203 Private method to jump to the line of the selected global entry and to | |
| 204 populate the members combo box. | |
| 205 </p> | |
| 206 <dl> | |
| 207 | |
| 208 <dt><i>index</i> (int)</dt> | |
| 209 <dd> | |
| 210 index of the selected entry | |
| 211 </dd> | |
| 212 <dt><i>moveCursor</i> (bool)</dt> | |
| 213 <dd> | |
| 214 flag indicating to move the editor cursor | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="EditorAssembly.__membersActivated" ID="EditorAssembly.__membersActivated"></a> | |
| 218 <h4>EditorAssembly.__membersActivated</h4> | |
| 219 <b>__membersActivated</b>(<i>index, moveCursor=True</i>) | |
| 220 | |
| 221 <p> | |
| 222 Private method to jump to the line of the selected members entry. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>index</i> (int)</dt> | |
| 227 <dd> | |
| 228 index of the selected entry | |
| 229 </dd> | |
| 230 <dt><i>moveCursor</i> (bool)</dt> | |
| 231 <dd> | |
| 232 flag indicating to move the editor cursor | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <a NAME="EditorAssembly.__parseEditor" ID="EditorAssembly.__parseEditor"></a> | |
| 236 <h4>EditorAssembly.__parseEditor</h4> | |
| 237 <b>__parseEditor</b>(<i></i>) | |
| 238 | |
| 239 <p> | |
| 240 Private method to parse the editor source and repopulate the globals | |
| 241 combo. | |
| 242 </p> | |
| 243 <a NAME="EditorAssembly.__preferencesChanged" ID="EditorAssembly.__preferencesChanged"></a> | |
| 244 <h4>EditorAssembly.__preferencesChanged</h4> | |
| 245 <b>__preferencesChanged</b>(<i></i>) | |
| 246 | |
| 247 <p> | |
| 248 Private slot handling a change of preferences. | |
| 249 </p> | |
| 250 <a NAME="EditorAssembly.__resetParseTimer" ID="EditorAssembly.__resetParseTimer"></a> | |
| 251 <h4>EditorAssembly.__resetParseTimer</h4> | |
| 252 <b>__resetParseTimer</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Private slot to reset the parse timer. | |
| 256 </p> | |
| 257 <a NAME="EditorAssembly.getEditor" ID="EditorAssembly.getEditor"></a> | |
| 258 <h4>EditorAssembly.getEditor</h4> | |
| 259 <b>getEditor</b>(<i></i>) | |
| 260 | |
| 261 <p> | |
| 262 Public method to get the reference to the editor widget. | |
| 263 </p> | |
| 264 <dl> | |
| 265 <dt>Return:</dt> | |
| 266 <dd> | |
| 267 reference to the editor widget | |
| 268 </dd> | |
| 269 </dl> | |
| 270 <dl> | |
| 271 <dt>Return Type:</dt> | |
| 272 <dd> | |
| 273 Editor | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="EditorAssembly.shutdownTimer" ID="EditorAssembly.shutdownTimer"></a> | |
| 277 <h4>EditorAssembly.shutdownTimer</h4> | |
| 278 <b>shutdownTimer</b>(<i></i>) | |
| 279 | |
| 280 <p> | |
| 281 Public method to stop and disconnect the timer. | |
| 282 </p> | |
| 283 <div align="right"><a href="#top">Up</a></div> | |
| 284 <hr /> | |
| 285 </body></html> |
