Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricCompleters.html
src/eric7/Documentation/Source/eric7.EricWidgets.EricCompleters.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricWidgets.EricCompleters</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.EricWidgets.EricCompleters</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing various kinds of completers. | |
| 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="#EricDirCompleter">EricDirCompleter</a></td> | |
| 25 <td>Class implementing a completer for directory names.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#EricFileCompleter">EricFileCompleter</a></td> | |
| 29 <td>Class implementing a completer for file names.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#EricStringListCompleter">EricStringListCompleter</a></td> | |
| 33 <td>Class implementing a completer for string lists.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="EricDirCompleter" ID="EricDirCompleter"></a> | |
| 44 <h2>EricDirCompleter</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class implementing a completer for directory names. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QCompleter | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#EricDirCompleter.__init__">EricDirCompleter</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EricDirCompleter.rootPath">rootPath</a></td> | |
| 71 <td>Public method to get the root path of the model.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EricDirCompleter.setRootPath">setRootPath</a></td> | |
| 75 <td>Public method to set the root path of the model.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="EricDirCompleter.__init__" ID="EricDirCompleter.__init__"></a> | |
| 85 <h4>EricDirCompleter (Constructor)</h4> | |
| 86 <b>EricDirCompleter</b>(<i>parent=None, completionMode=QCompleter.CompletionMode.PopupCompletion, showHidden=False</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>parent</i></dt> | |
| 94 <dd> | |
| 95 parent widget of the completer (QWidget) | |
| 96 </dd> | |
| 97 <dt><i>completionMode</i></dt> | |
| 98 <dd> | |
| 99 completion mode of the | |
| 100 completer (QCompleter.CompletionMode) | |
| 101 </dd> | |
| 102 <dt><i>showHidden</i></dt> | |
| 103 <dd> | |
| 104 flag indicating to show hidden entries as well | |
| 105 (boolean) | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <a NAME="EricDirCompleter.rootPath" ID="EricDirCompleter.rootPath"></a> | |
| 109 <h4>EricDirCompleter.rootPath</h4> | |
| 110 <b>rootPath</b>(<i></i>) | |
| 111 | |
| 112 <p> | |
| 113 Public method to get the root path of the model. | |
| 114 </p> | |
| 115 <dl> | |
| 116 <dt>Return:</dt> | |
| 117 <dd> | |
| 118 root path of the model | |
| 119 </dd> | |
| 120 </dl> | |
| 121 <dl> | |
| 122 <dt>Return Type:</dt> | |
| 123 <dd> | |
| 124 str | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <a NAME="EricDirCompleter.setRootPath" ID="EricDirCompleter.setRootPath"></a> | |
| 128 <h4>EricDirCompleter.setRootPath</h4> | |
| 129 <b>setRootPath</b>(<i>path</i>) | |
| 130 | |
| 131 <p> | |
| 132 Public method to set the root path of the model. | |
| 133 </p> | |
| 134 <dl> | |
| 135 | |
| 136 <dt><i>path</i> (str)</dt> | |
| 137 <dd> | |
| 138 root path for the model | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <div align="right"><a href="#top">Up</a></div> | |
| 142 <hr /> | |
| 143 <hr /> | |
| 144 <a NAME="EricFileCompleter" ID="EricFileCompleter"></a> | |
| 145 <h2>EricFileCompleter</h2> | |
| 146 | |
| 147 <p> | |
| 148 Class implementing a completer for file names. | |
| 149 </p> | |
| 150 <h3>Derived from</h3> | |
| 151 QCompleter | |
| 152 <h3>Class Attributes</h3> | |
| 153 | |
| 154 <table> | |
| 155 <tr><td>None</td></tr> | |
| 156 </table> | |
| 157 <h3>Class Methods</h3> | |
| 158 | |
| 159 <table> | |
| 160 <tr><td>None</td></tr> | |
| 161 </table> | |
| 162 <h3>Methods</h3> | |
| 163 | |
| 164 <table> | |
| 165 | |
| 166 <tr> | |
| 167 <td><a href="#EricFileCompleter.__init__">EricFileCompleter</a></td> | |
| 168 <td>Constructor</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#EricFileCompleter.rootPath">rootPath</a></td> | |
| 172 <td>Public method to get the root path of the model.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#EricFileCompleter.setRootPath">setRootPath</a></td> | |
| 176 <td>Public method to set the root path of the model.</td> | |
| 177 </tr> | |
| 178 </table> | |
| 179 <h3>Static Methods</h3> | |
| 180 | |
| 181 <table> | |
| 182 <tr><td>None</td></tr> | |
| 183 </table> | |
| 184 | |
| 185 <a NAME="EricFileCompleter.__init__" ID="EricFileCompleter.__init__"></a> | |
| 186 <h4>EricFileCompleter (Constructor)</h4> | |
| 187 <b>EricFileCompleter</b>(<i>parent=None, completionMode=QCompleter.CompletionMode.PopupCompletion, showHidden=False</i>) | |
| 188 | |
| 189 <p> | |
| 190 Constructor | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>parent</i></dt> | |
| 195 <dd> | |
| 196 parent widget of the completer (QWidget) | |
| 197 </dd> | |
| 198 <dt><i>completionMode</i></dt> | |
| 199 <dd> | |
| 200 completion mode of the | |
| 201 completer (QCompleter.CompletionMode) | |
| 202 </dd> | |
| 203 <dt><i>showHidden</i></dt> | |
| 204 <dd> | |
| 205 flag indicating to show hidden entries as well | |
| 206 (boolean) | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <a NAME="EricFileCompleter.rootPath" ID="EricFileCompleter.rootPath"></a> | |
| 210 <h4>EricFileCompleter.rootPath</h4> | |
| 211 <b>rootPath</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Public method to get the root path of the model. | |
| 215 </p> | |
| 216 <dl> | |
| 217 <dt>Return:</dt> | |
| 218 <dd> | |
| 219 root path of the model | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <dl> | |
| 223 <dt>Return Type:</dt> | |
| 224 <dd> | |
| 225 str | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="EricFileCompleter.setRootPath" ID="EricFileCompleter.setRootPath"></a> | |
| 229 <h4>EricFileCompleter.setRootPath</h4> | |
| 230 <b>setRootPath</b>(<i>path</i>) | |
| 231 | |
| 232 <p> | |
| 233 Public method to set the root path of the model. | |
| 234 </p> | |
| 235 <dl> | |
| 236 | |
| 237 <dt><i>path</i> (str)</dt> | |
| 238 <dd> | |
| 239 root path for the model | |
| 240 </dd> | |
| 241 </dl> | |
| 242 <div align="right"><a href="#top">Up</a></div> | |
| 243 <hr /> | |
| 244 <hr /> | |
| 245 <a NAME="EricStringListCompleter" ID="EricStringListCompleter"></a> | |
| 246 <h2>EricStringListCompleter</h2> | |
| 247 | |
| 248 <p> | |
| 249 Class implementing a completer for string lists. | |
| 250 </p> | |
| 251 <h3>Derived from</h3> | |
| 252 QCompleter | |
| 253 <h3>Class Attributes</h3> | |
| 254 | |
| 255 <table> | |
| 256 <tr><td>None</td></tr> | |
| 257 </table> | |
| 258 <h3>Class Methods</h3> | |
| 259 | |
| 260 <table> | |
| 261 <tr><td>None</td></tr> | |
| 262 </table> | |
| 263 <h3>Methods</h3> | |
| 264 | |
| 265 <table> | |
| 266 | |
| 267 <tr> | |
| 268 <td><a href="#EricStringListCompleter.__init__">EricStringListCompleter</a></td> | |
| 269 <td>Constructor</td> | |
| 270 </tr> | |
| 271 </table> | |
| 272 <h3>Static Methods</h3> | |
| 273 | |
| 274 <table> | |
| 275 <tr><td>None</td></tr> | |
| 276 </table> | |
| 277 | |
| 278 <a NAME="EricStringListCompleter.__init__" ID="EricStringListCompleter.__init__"></a> | |
| 279 <h4>EricStringListCompleter (Constructor)</h4> | |
| 280 <b>EricStringListCompleter</b>(<i>parent=None, strings=None, completionMode=QCompleter.CompletionMode.PopupCompletion</i>) | |
| 281 | |
| 282 <p> | |
| 283 Constructor | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>parent</i></dt> | |
| 288 <dd> | |
| 289 parent widget of the completer (QWidget) | |
| 290 </dd> | |
| 291 <dt><i>strings</i></dt> | |
| 292 <dd> | |
| 293 list of string to load into the completer | |
| 294 (list of strings) | |
| 295 </dd> | |
| 296 <dt><i>completionMode</i></dt> | |
| 297 <dd> | |
| 298 completion mode of the | |
| 299 completer (QCompleter.CompletionMode) | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <div align="right"><a href="#top">Up</a></div> | |
| 303 <hr /> | |
| 304 </body></html> |
