Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.EditorOutlineModel.html
src/eric7/Documentation/Source/eric7.QScintilla.EditorOutlineModel.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9612
- 93b496cc3c88
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.EditorOutlineModel</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.EditorOutlineModel</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the editor outline model. | |
| 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="#EditorOutlineModel">EditorOutlineModel</a></td> | |
| 25 <td>Class implementing the editor outline model.</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="EditorOutlineModel" ID="EditorOutlineModel"></a> | |
| 36 <h2>EditorOutlineModel</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the editor outline model. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 BrowserModel | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>SupportedLanguages</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#EditorOutlineModel.__init__">EditorOutlineModel</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#EditorOutlineModel.__populateModel">__populateModel</a></td> | |
| 63 <td>Private slot to populate the model.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EditorOutlineModel.editor">editor</a></td> | |
| 67 <td>Public method to retrieve a reference to the editor.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EditorOutlineModel.fileName">fileName</a></td> | |
| 71 <td>Public method to retrieve the file name of the editor.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EditorOutlineModel.findItem">findItem</a></td> | |
| 75 <td>Function to iteratively search for an item containing the given line.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EditorOutlineModel.isPopulated">isPopulated</a></td> | |
| 79 <td>Public method to check, if the model is populated.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EditorOutlineModel.itemIndexByLine">itemIndexByLine</a></td> | |
| 83 <td>Public method to find an item's index given a line number.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EditorOutlineModel.repopulate">repopulate</a></td> | |
| 87 <td>Public slot to repopulate the model.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="EditorOutlineModel.__init__" ID="EditorOutlineModel.__init__"></a> | |
| 97 <h4>EditorOutlineModel (Constructor)</h4> | |
| 98 <b>EditorOutlineModel</b>(<i>editor, populate=True</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>editor</i> (Editor)</dt> | |
| 106 <dd> | |
| 107 reference to the editor containing the source text | |
| 108 </dd> | |
| 109 <dt><i>populate</i> (bool)</dt> | |
| 110 <dd> | |
| 111 flag indicating to populate the outline | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <a NAME="EditorOutlineModel.__populateModel" ID="EditorOutlineModel.__populateModel"></a> | |
| 115 <h4>EditorOutlineModel.__populateModel</h4> | |
| 116 <b>__populateModel</b>(<i>repopulate=False</i>) | |
| 117 | |
| 118 <p> | |
| 119 Private slot to populate the model. | |
| 120 </p> | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>repopulate</i> (bool)</dt> | |
| 124 <dd> | |
| 125 flag indicating a repopulation | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="EditorOutlineModel.editor" ID="EditorOutlineModel.editor"></a> | |
| 129 <h4>EditorOutlineModel.editor</h4> | |
| 130 <b>editor</b>(<i></i>) | |
| 131 | |
| 132 <p> | |
| 133 Public method to retrieve a reference to the editor. | |
| 134 </p> | |
| 135 <dl> | |
| 136 <dt>Return:</dt> | |
| 137 <dd> | |
| 138 reference to the editor | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <dl> | |
| 142 <dt>Return Type:</dt> | |
| 143 <dd> | |
| 144 Editor | |
| 145 </dd> | |
| 146 </dl> | |
| 147 <a NAME="EditorOutlineModel.fileName" ID="EditorOutlineModel.fileName"></a> | |
| 148 <h4>EditorOutlineModel.fileName</h4> | |
| 149 <b>fileName</b>(<i></i>) | |
| 150 | |
| 151 <p> | |
| 152 Public method to retrieve the file name of the editor. | |
| 153 </p> | |
| 154 <dl> | |
| 155 <dt>Return:</dt> | |
| 156 <dd> | |
| 157 file name of the editor | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <dl> | |
| 161 <dt>Return Type:</dt> | |
| 162 <dd> | |
| 163 str | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="EditorOutlineModel.findItem" ID="EditorOutlineModel.findItem"></a> | |
| 167 <h4>EditorOutlineModel.findItem</h4> | |
| 168 <b>findItem</b>(<i>parent</i>) | |
| 169 | |
| 170 <p> | |
| 171 Function to iteratively search for an item containing the given | |
| 172 line. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>lineno</i> (int)</dt> | |
| 177 <dd> | |
| 178 one based line number of the item | |
| 179 </dd> | |
| 180 <dt><i>parent</i> (BrowserItem)</dt> | |
| 181 <dd> | |
| 182 reference to the parent item | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <dl> | |
| 186 <dt>Return:</dt> | |
| 187 <dd> | |
| 188 found item or None | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <dl> | |
| 192 <dt>Return Type:</dt> | |
| 193 <dd> | |
| 194 BrowserItem | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="EditorOutlineModel.isPopulated" ID="EditorOutlineModel.isPopulated"></a> | |
| 198 <h4>EditorOutlineModel.isPopulated</h4> | |
| 199 <b>isPopulated</b>(<i></i>) | |
| 200 | |
| 201 <p> | |
| 202 Public method to check, if the model is populated. | |
| 203 </p> | |
| 204 <dl> | |
| 205 <dt>Return:</dt> | |
| 206 <dd> | |
| 207 flag indicating a populated model | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <dl> | |
| 211 <dt>Return Type:</dt> | |
| 212 <dd> | |
| 213 bool | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <a NAME="EditorOutlineModel.itemIndexByLine" ID="EditorOutlineModel.itemIndexByLine"></a> | |
| 217 <h4>EditorOutlineModel.itemIndexByLine</h4> | |
| 218 <b>itemIndexByLine</b>(<i>lineno</i>) | |
| 219 | |
| 220 <p> | |
| 221 Public method to find an item's index given a line number. | |
| 222 </p> | |
| 223 <dl> | |
| 224 | |
| 225 <dt><i>lineno</i> (int)</dt> | |
| 226 <dd> | |
| 227 one based line number of the item | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <dl> | |
| 231 <dt>Return:</dt> | |
| 232 <dd> | |
| 233 index of the item found | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <dl> | |
| 237 <dt>Return Type:</dt> | |
| 238 <dd> | |
| 239 QModelIndex | |
| 240 </dd> | |
| 241 </dl> | |
| 242 <a NAME="EditorOutlineModel.repopulate" ID="EditorOutlineModel.repopulate"></a> | |
| 243 <h4>EditorOutlineModel.repopulate</h4> | |
| 244 <b>repopulate</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Public slot to repopulate the model. | |
| 248 </p> | |
| 249 <div align="right"><a href="#top">Up</a></div> | |
| 250 <hr /> | |
| 251 </body></html> |
