Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricDirFileDialog.html
src/eric7/Documentation/Source/eric7.EricWidgets.EricDirFileDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9239
- 3c605ab5a8c7
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricWidgets.EricDirFileDialog</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.EricDirFileDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to select files and directories simultaneously. | |
| 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="#EricDirFileDialog">EricDirFileDialog</a></td> | |
| 25 <td>Derived QFileDialog to select files and directories simultaneously.</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="EricDirFileDialog" ID="EricDirFileDialog"></a> | |
| 36 <h2>EricDirFileDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Derived QFileDialog to select files and directories simultaneously. | |
| 40 </p> | |
| 41 <p> | |
| 42 For this purpose the none native file dialog is used. | |
| 43 </p> | |
| 44 <h3>Derived from</h3> | |
| 45 QFileDialog | |
| 46 <h3>Class Attributes</h3> | |
| 47 | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 <h3>Class Methods</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 | |
| 60 <tr> | |
| 61 <td><a href="#EricDirFileDialog.__init__">EricDirFileDialog</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#EricDirFileDialog.accept">accept</a></td> | |
| 66 <td>Public slot to update the list with the selected files and folders.</td> | |
| 67 </tr> | |
| 68 <tr> | |
| 69 <td><a href="#EricDirFileDialog.exec">exec</a></td> | |
| 70 <td>Public slot to finalize initialization and start the event loop.</td> | |
| 71 </tr> | |
| 72 <tr> | |
| 73 <td><a href="#EricDirFileDialog.on_directoryEntered">on_directoryEntered</a></td> | |
| 74 <td>Private slot to reset selections if another directory was entered.</td> | |
| 75 </tr> | |
| 76 <tr> | |
| 77 <td><a href="#EricDirFileDialog.on_selectionChanged">on_selectionChanged</a></td> | |
| 78 <td>Private method to determine the selected files and folders and update the line edit.</td> | |
| 79 </tr> | |
| 80 </table> | |
| 81 <h3>Static Methods</h3> | |
| 82 | |
| 83 <table> | |
| 84 | |
| 85 <tr> | |
| 86 <td><a href="#EricDirFileDialog.getOpenFileAndDirNames">getOpenFileAndDirNames</a></td> | |
| 87 <td>Static method to get the names of files and directories for opening it.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 | |
| 91 <a NAME="EricDirFileDialog.__init__" ID="EricDirFileDialog.__init__"></a> | |
| 92 <h4>EricDirFileDialog (Constructor)</h4> | |
| 93 <b>EricDirFileDialog</b>(<i>parent=None, caption="", directory="", filterStr=""</i>) | |
| 94 | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p> | |
| 98 <dl> | |
| 99 | |
| 100 <dt><i>parent</i> (QWidget)</dt> | |
| 101 <dd> | |
| 102 parent widget of the dialog | |
| 103 </dd> | |
| 104 <dt><i>caption</i> (str)</dt> | |
| 105 <dd> | |
| 106 window title of the dialog | |
| 107 </dd> | |
| 108 <dt><i>directory</i> (str)</dt> | |
| 109 <dd> | |
| 110 working directory of the dialog | |
| 111 </dd> | |
| 112 <dt><i>filterStr</i> (str)</dt> | |
| 113 <dd> | |
| 114 filter string for the dialog | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <a NAME="EricDirFileDialog.accept" ID="EricDirFileDialog.accept"></a> | |
| 118 <h4>EricDirFileDialog.accept</h4> | |
| 119 <b>accept</b>(<i></i>) | |
| 120 | |
| 121 <p> | |
| 122 Public slot to update the list with the selected files and folders. | |
| 123 </p> | |
| 124 <a NAME="EricDirFileDialog.exec" ID="EricDirFileDialog.exec"></a> | |
| 125 <h4>EricDirFileDialog.exec</h4> | |
| 126 <b>exec</b>(<i></i>) | |
| 127 | |
| 128 <p> | |
| 129 Public slot to finalize initialization and start the event loop. | |
| 130 </p> | |
| 131 <dl> | |
| 132 <dt>Return:</dt> | |
| 133 <dd> | |
| 134 accepted or rejected | |
| 135 </dd> | |
| 136 </dl> | |
| 137 <dl> | |
| 138 <dt>Return Type:</dt> | |
| 139 <dd> | |
| 140 QDialog.DialogCode | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="EricDirFileDialog.on_directoryEntered" ID="EricDirFileDialog.on_directoryEntered"></a> | |
| 144 <h4>EricDirFileDialog.on_directoryEntered</h4> | |
| 145 <b>on_directoryEntered</b>(<i>directory</i>) | |
| 146 | |
| 147 <p> | |
| 148 Private slot to reset selections if another directory was entered. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>directory</i> (str)</dt> | |
| 153 <dd> | |
| 154 name of the directory entered | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="EricDirFileDialog.on_selectionChanged" ID="EricDirFileDialog.on_selectionChanged"></a> | |
| 158 <h4>EricDirFileDialog.on_selectionChanged</h4> | |
| 159 <b>on_selectionChanged</b>(<i>selected, deselected</i>) | |
| 160 | |
| 161 <p> | |
| 162 Private method to determine the selected files and folders and update | |
| 163 the line edit. | |
| 164 </p> | |
| 165 <dl> | |
| 166 | |
| 167 <dt><i>selected</i> (QItemSelection)</dt> | |
| 168 <dd> | |
| 169 newly selected entries | |
| 170 </dd> | |
| 171 <dt><i>deselected</i> (QItemSelection)</dt> | |
| 172 <dd> | |
| 173 deselected entries | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <a NAME="EricDirFileDialog.getOpenFileAndDirNames" ID="EricDirFileDialog.getOpenFileAndDirNames"></a> | |
| 177 <h4>EricDirFileDialog.getOpenFileAndDirNames (static)</h4> | |
| 178 <b>getOpenFileAndDirNames</b>(<i>caption="", directory="", filterStr="", options=None</i>) | |
| 179 | |
| 180 <p> | |
| 181 Static method to get the names of files and directories for opening it. | |
| 182 </p> | |
| 183 <dl> | |
| 184 | |
| 185 <dt><i>parent</i> (QWidget)</dt> | |
| 186 <dd> | |
| 187 parent widget of the dialog | |
| 188 </dd> | |
| 189 <dt><i>caption</i> (str)</dt> | |
| 190 <dd> | |
| 191 window title of the dialog | |
| 192 </dd> | |
| 193 <dt><i>directory</i> (str)</dt> | |
| 194 <dd> | |
| 195 working directory of the dialog | |
| 196 </dd> | |
| 197 <dt><i>filterStr</i> (str)</dt> | |
| 198 <dd> | |
| 199 filter string for the dialog | |
| 200 </dd> | |
| 201 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 202 <dd> | |
| 203 various options for the dialog | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <dl> | |
| 207 <dt>Return:</dt> | |
| 208 <dd> | |
| 209 names of the selected files and folders | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return Type:</dt> | |
| 214 <dd> | |
| 215 list of str | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <div align="right"><a href="#top">Up</a></div> | |
| 219 <hr /> | |
| 220 </body></html> |
