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