Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.AddDirectoryDialog.html
src/eric7/Documentation/Source/eric7.Project.AddDirectoryDialog.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.Project.AddDirectoryDialog</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.Project.AddDirectoryDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to add files of a directory to the project. | |
| 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="#AddDirectoryDialog">AddDirectoryDialog</a></td> | |
| 25 <td>Class implementing a dialog to add files of a directory to the project.</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="AddDirectoryDialog" ID="AddDirectoryDialog"></a> | |
| 36 <h2>AddDirectoryDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to add files of a directory to the project. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_AddDirectoryDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</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="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#AddDirectoryDialog.getData">getData</a></td> | |
| 63 <td>Public slot to retrieve the dialogs data.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td> | |
| 67 <td>Private slot to handle the selection of a file type.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> | |
| 71 <td>Private slot to handle the source directory text changed.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> | |
| 81 <h4>AddDirectoryDialog (Constructor)</h4> | |
| 82 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>pro</i></dt> | |
| 90 <dd> | |
| 91 reference to the project object | |
| 92 </dd> | |
| 93 <dt><i>fileTypeFilter</i></dt> | |
| 94 <dd> | |
| 95 file type filter (string) | |
| 96 </dd> | |
| 97 <dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 parent widget of this dialog (QWidget) | |
| 100 </dd> | |
| 101 <dt><i>name</i></dt> | |
| 102 <dd> | |
| 103 name of this dialog (string) | |
| 104 </dd> | |
| 105 <dt><i>startdir</i></dt> | |
| 106 <dd> | |
| 107 start directory for the selection dialog | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> | |
| 111 <h4>AddDirectoryDialog.getData</h4> | |
| 112 <b>getData</b>(<i></i>) | |
| 113 | |
| 114 <p> | |
| 115 Public slot to retrieve the dialogs data. | |
| 116 </p> | |
| 117 <dl> | |
| 118 <dt>Return:</dt> | |
| 119 <dd> | |
| 120 tuple of four values (string, string, string, boolean) giving | |
| 121 the selected file type, the source and target directory and | |
| 122 a flag indicating a recursive add | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a> | |
| 126 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4> | |
| 127 <b>on_filterComboBox_highlighted</b>(<i>index</i>) | |
| 128 | |
| 129 <p> | |
| 130 Private slot to handle the selection of a file type. | |
| 131 </p> | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>index</i> (int)</dt> | |
| 135 <dd> | |
| 136 index of the selected entry | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> | |
| 140 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> | |
| 141 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) | |
| 142 | |
| 143 <p> | |
| 144 Private slot to handle the source directory text changed. | |
| 145 </p> | |
| 146 <p> | |
| 147 If the entered source directory is a subdirectory of the current | |
| 148 projects main directory, the target directory path is synchronized. | |
| 149 It is assumed, that the user wants to add a bunch of files to | |
| 150 the project in place. | |
| 151 </p> | |
| 152 <dl> | |
| 153 | |
| 154 <dt><i>directory</i></dt> | |
| 155 <dd> | |
| 156 the text of the source directory line edit (string) | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <div align="right"><a href="#top">Up</a></div> | |
| 160 <hr /> | |
| 161 </body></html> |
