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