Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Project.AddDirectoryDialog.html
eric6/Documentation/Source/eric6.Project.AddDirectoryDialog.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Project.AddDirectoryDialog</h1> | 23 <h1>eric6.Project.AddDirectoryDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog to add files of a directory to the project. | 26 Module implementing a dialog to add files of a directory to the project. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> | 38 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> |
| 34 <td>Class implementing a dialog to add files of a directory to the project.</td> | 39 <td>Class implementing a dialog to add files of a directory to the project.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> | 49 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> |
| 43 <h2>AddDirectoryDialog</h2> | 50 <h2>AddDirectoryDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog to add files of a directory to the project. | 53 Class implementing a dialog to add files of a directory to the project. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog, Ui_AddDirectoryDialog | 56 QDialog, Ui_AddDirectoryDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> | 72 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#AddDirectoryDialog.getData">getData</a></td> | 76 <td><a href="#AddDirectoryDialog.getData">getData</a></td> |
| 64 <td>Public slot to retrieve the dialogs data.</td> | 77 <td>Public slot to retrieve the dialogs data.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td> | 80 <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> | 81 <td>Private slot to handle the selection of a file type.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> | 84 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> |
| 70 <td>Private slot to handle the source directory text changed.</td> | 85 <td>Private slot to handle the source directory text changed.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> | 94 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> |
| 78 <h4>AddDirectoryDialog (Constructor)</h4> | 95 <h4>AddDirectoryDialog (Constructor)</h4> |
| 79 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>) | 96 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 83 <dt><i>pro</i></dt> | 103 <dt><i>pro</i></dt> |
| 84 <dd> | 104 <dd> |
| 85 reference to the project object | 105 reference to the project object |
| 86 </dd><dt><i>fileTypeFilter</i></dt> | 106 </dd> |
| 107 <dt><i>fileTypeFilter</i></dt> | |
| 87 <dd> | 108 <dd> |
| 88 file type filter (string) | 109 file type filter (string) |
| 89 </dd><dt><i>parent</i></dt> | 110 </dd> |
| 111 <dt><i>parent</i></dt> | |
| 90 <dd> | 112 <dd> |
| 91 parent widget of this dialog (QWidget) | 113 parent widget of this dialog (QWidget) |
| 92 </dd><dt><i>name</i></dt> | 114 </dd> |
| 115 <dt><i>name</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 name of this dialog (string) | 117 name of this dialog (string) |
| 95 </dd><dt><i>startdir</i></dt> | 118 </dd> |
| 119 <dt><i>startdir</i></dt> | |
| 96 <dd> | 120 <dd> |
| 97 start directory for the selection dialog | 121 start directory for the selection dialog |
| 98 </dd> | 122 </dd> |
| 99 </dl><a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> | 123 </dl> |
| 124 <a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> | |
| 100 <h4>AddDirectoryDialog.getData</h4> | 125 <h4>AddDirectoryDialog.getData</h4> |
| 101 <b>getData</b>(<i></i>) | 126 <b>getData</b>(<i></i>) |
| 127 | |
| 102 <p> | 128 <p> |
| 103 Public slot to retrieve the dialogs data. | 129 Public slot to retrieve the dialogs data. |
| 104 </p><dl> | 130 </p> |
| 131 <dl> | |
| 105 <dt>Returns:</dt> | 132 <dt>Returns:</dt> |
| 106 <dd> | 133 <dd> |
| 107 tuple of four values (string, string, string, boolean) giving | 134 tuple of four values (string, string, string, boolean) giving |
| 108 the selected file type, the source and target directory and | 135 the selected file type, the source and target directory and |
| 109 a flag indicating a recursive add | 136 a flag indicating a recursive add |
| 110 </dd> | 137 </dd> |
| 111 </dl><a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a> | 138 </dl> |
| 139 <a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a> | |
| 112 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4> | 140 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4> |
| 113 <b>on_filterComboBox_highlighted</b>(<i>fileType</i>) | 141 <b>on_filterComboBox_highlighted</b>(<i>fileType</i>) |
| 142 | |
| 114 <p> | 143 <p> |
| 115 Private slot to handle the selection of a file type. | 144 Private slot to handle the selection of a file type. |
| 116 </p><dl> | 145 </p> |
| 146 <dl> | |
| 147 | |
| 117 <dt><i>fileType</i></dt> | 148 <dt><i>fileType</i></dt> |
| 118 <dd> | 149 <dd> |
| 119 the selected file type (string) | 150 the selected file type (string) |
| 120 </dd> | 151 </dd> |
| 121 </dl><a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> | 152 </dl> |
| 153 <a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> | |
| 122 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> | 154 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> |
| 123 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) | 155 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) |
| 156 | |
| 124 <p> | 157 <p> |
| 125 Private slot to handle the source directory text changed. | 158 Private slot to handle the source directory text changed. |
| 126 </p><p> | 159 </p> |
| 160 <p> | |
| 127 If the entered source directory is a subdirectory of the current | 161 If the entered source directory is a subdirectory of the current |
| 128 projects main directory, the target directory path is synchronized. | 162 projects main directory, the target directory path is synchronized. |
| 129 It is assumed, that the user wants to add a bunch of files to | 163 It is assumed, that the user wants to add a bunch of files to |
| 130 the project in place. | 164 the project in place. |
| 131 </p><dl> | 165 </p> |
| 166 <dl> | |
| 167 | |
| 132 <dt><i>directory</i></dt> | 168 <dt><i>directory</i></dt> |
| 133 <dd> | 169 <dd> |
| 134 the text of the source directory line edit (string) | 170 the text of the source directory line edit (string) |
| 135 </dd> | 171 </dd> |
| 136 </dl> | 172 </dl> |
