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 10479
- 856476537696
- parent 10430
- e440aaf179ce
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Project.AddDirectoryDialog</h1> | 9 <h1>eric7.Project.AddDirectoryDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to add files of a directory to the project. | 11 Module implementing a dialog to add files of a directory to the project. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> | 22 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> |
| 25 <td>Class implementing a dialog to add files of a directory to the project.</td> | 23 <td>Class implementing a dialog to add files of a directory to the project.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> | 34 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> |
| 36 <h2>AddDirectoryDialog</h2> | 35 <h2>AddDirectoryDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to add files of a directory to the project. | 37 Class implementing a dialog to add files of a directory to the project. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_AddDirectoryDialog | 41 QDialog, Ui_AddDirectoryDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>None</td></tr> | 44 <tr><td>None</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | |
| 55 <table> | 53 <table> |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> | 55 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 69 <tr> | 66 <tr> |
| 70 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> | 67 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> |
| 71 <td>Private slot to handle the source directory text changed.</td> | 68 <td>Private slot to handle the source directory text changed.</td> |
| 72 </tr> | 69 </tr> |
| 73 </table> | 70 </table> |
| 71 | |
| 74 <h3>Static Methods</h3> | 72 <h3>Static Methods</h3> |
| 75 | |
| 76 <table> | 73 <table> |
| 77 <tr><td>None</td></tr> | 74 <tr><td>None</td></tr> |
| 78 </table> | 75 </table> |
| 79 | 76 |
| 77 | |
| 80 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> | 78 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> |
| 81 <h4>AddDirectoryDialog (Constructor)</h4> | 79 <h4>AddDirectoryDialog (Constructor)</h4> |
| 82 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter="SOURCES", parent=None, name=None, startdir=None</i>) | 80 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter="SOURCES", parent=None, name=None, startdir=None</i>) |
| 83 | |
| 84 <p> | 81 <p> |
| 85 Constructor | 82 Constructor |
| 86 </p> | 83 </p> |
| 84 | |
| 87 <dl> | 85 <dl> |
| 88 | 86 |
| 89 <dt><i>pro</i> (Project)</dt> | 87 <dt><i>pro</i> (Project)</dt> |
| 90 <dd> | 88 <dd> |
| 91 reference to the project object | 89 reference to the project object |
| 108 </dd> | 106 </dd> |
| 109 </dl> | 107 </dl> |
| 110 <a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> | 108 <a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> |
| 111 <h4>AddDirectoryDialog.getData</h4> | 109 <h4>AddDirectoryDialog.getData</h4> |
| 112 <b>getData</b>(<i></i>) | 110 <b>getData</b>(<i></i>) |
| 113 | |
| 114 <p> | 111 <p> |
| 115 Public slot to retrieve the dialogs data. | 112 Public slot to retrieve the dialogs data. |
| 116 </p> | 113 </p> |
| 114 | |
| 117 <dl> | 115 <dl> |
| 118 <dt>Return:</dt> | 116 <dt>Return:</dt> |
| 119 <dd> | 117 <dd> |
| 120 tuple of four values giving the selected file type, the source | 118 tuple of four values giving the selected file type, the source |
| 121 and target directory and a flag indicating a recursive add | 119 and target directory and a flag indicating a recursive add |
| 128 </dd> | 126 </dd> |
| 129 </dl> | 127 </dl> |
| 130 <a NAME="AddDirectoryDialog.on_filterComboBox_currentIndexChanged" ID="AddDirectoryDialog.on_filterComboBox_currentIndexChanged"></a> | 128 <a NAME="AddDirectoryDialog.on_filterComboBox_currentIndexChanged" ID="AddDirectoryDialog.on_filterComboBox_currentIndexChanged"></a> |
| 131 <h4>AddDirectoryDialog.on_filterComboBox_currentIndexChanged</h4> | 129 <h4>AddDirectoryDialog.on_filterComboBox_currentIndexChanged</h4> |
| 132 <b>on_filterComboBox_currentIndexChanged</b>(<i>index</i>) | 130 <b>on_filterComboBox_currentIndexChanged</b>(<i>index</i>) |
| 133 | |
| 134 <p> | 131 <p> |
| 135 Private slot to handle the selection of a file type. | 132 Private slot to handle the selection of a file type. |
| 136 </p> | 133 </p> |
| 134 | |
| 137 <dl> | 135 <dl> |
| 138 | 136 |
| 139 <dt><i>index</i> (int)</dt> | 137 <dt><i>index</i> (int)</dt> |
| 140 <dd> | 138 <dd> |
| 141 index of the selected entry | 139 index of the selected entry |
| 142 </dd> | 140 </dd> |
| 143 </dl> | 141 </dl> |
| 144 <a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> | 142 <a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> |
| 145 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> | 143 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> |
| 146 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) | 144 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) |
| 147 | |
| 148 <p> | 145 <p> |
| 149 Private slot to handle the source directory text changed. | 146 Private slot to handle the source directory text changed. |
| 150 </p> | 147 </p> |
| 151 <p> | 148 <p> |
| 152 If the entered source directory is a subdirectory of the current | 149 If the entered source directory is a subdirectory of the current |
| 153 projects main directory, the target directory path is synchronized. | 150 projects main directory, the target directory path is synchronized. |
| 154 It is assumed, that the user wants to add a bunch of files to | 151 It is assumed, that the user wants to add a bunch of files to |
| 155 the project in place. | 152 the project in place. |
| 156 </p> | 153 </p> |
| 154 | |
| 157 <dl> | 155 <dl> |
| 158 | 156 |
| 159 <dt><i>directory</i> (str)</dt> | 157 <dt><i>directory</i> (str)</dt> |
| 160 <dd> | 158 <dd> |
| 161 the text of the source directory line edit | 159 the text of the source directory line edit |
