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