Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</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.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the data to add a submodule. | |
| 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="#GitSubmoduleAddDialog">GitSubmoduleAddDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the data to add a submodule.</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="GitSubmoduleAddDialog" ID="GitSubmoduleAddDialog"></a> | |
| 36 <h2>GitSubmoduleAddDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the data to add a submodule. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_GitSubmoduleAddDialog | |
| 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="#GitSubmoduleAddDialog.__init__">GitSubmoduleAddDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitSubmoduleAddDialog.__getRelativePath">__getRelativePath</a></td> | |
| 63 <td>Private method to convert a file path to a relative path.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitSubmoduleAddDialog.__saveHistory">__saveHistory</a></td> | |
| 67 <td>Private method to save the repository URL history.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitSubmoduleAddDialog.getData">getData</a></td> | |
| 71 <td>Public method to get the entered data.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitSubmoduleAddDialog.on_submoduleDirButton_clicked">on_submoduleDirButton_clicked</a></td> | |
| 75 <td>Private slot to display a directory selection dialog.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlButton_clicked">on_submoduleUrlButton_clicked</a></td> | |
| 79 <td>Private slot to display a directory selection dialog.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked">on_submoduleUrlClearHistoryButton_clicked</a></td> | |
| 83 <td>Private slot to clear the history of entered repository URLs.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged">on_submoduleUrlCombo_editTextChanged</a></td> | |
| 87 <td>Private slot to handle changes of the submodule repository URL.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="GitSubmoduleAddDialog.__init__" ID="GitSubmoduleAddDialog.__init__"></a> | |
| 97 <h4>GitSubmoduleAddDialog (Constructor)</h4> | |
| 98 <b>GitSubmoduleAddDialog</b>(<i>vcs, repodir, parent=None</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>vcs</i> (Git)</dt> | |
| 106 <dd> | |
| 107 reference to the version control object | |
| 108 </dd> | |
| 109 <dt><i>repodir</i> (str)</dt> | |
| 110 <dd> | |
| 111 directory containing the superproject | |
| 112 </dd> | |
| 113 <dt><i>parent</i> (QWidget)</dt> | |
| 114 <dd> | |
| 115 reference to the parent widget | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a> | |
| 119 <h4>GitSubmoduleAddDialog.__getRelativePath</h4> | |
| 120 <b>__getRelativePath</b>(<i>path</i>) | |
| 121 | |
| 122 <p> | |
| 123 Private method to convert a file path to a relative path. | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt><i>path</i> (str)</dt> | |
| 128 <dd> | |
| 129 file or directory name to convert | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <dl> | |
| 133 <dt>Return:</dt> | |
| 134 <dd> | |
| 135 relative path or unchanged path, if path doesn't | |
| 136 belong to the project | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <dl> | |
| 140 <dt>Return Type:</dt> | |
| 141 <dd> | |
| 142 str | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a> | |
| 146 <h4>GitSubmoduleAddDialog.__saveHistory</h4> | |
| 147 <b>__saveHistory</b>(<i></i>) | |
| 148 | |
| 149 <p> | |
| 150 Private method to save the repository URL history. | |
| 151 </p> | |
| 152 <a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a> | |
| 153 <h4>GitSubmoduleAddDialog.getData</h4> | |
| 154 <b>getData</b>(<i></i>) | |
| 155 | |
| 156 <p> | |
| 157 Public method to get the entered data. | |
| 158 </p> | |
| 159 <dl> | |
| 160 <dt>Return:</dt> | |
| 161 <dd> | |
| 162 tuple containing the repository URL, optional branch name, | |
| 163 optional logical name, optional submodule path and a flag | |
| 164 indicating to enforce the operation | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <dl> | |
| 168 <dt>Return Type:</dt> | |
| 169 <dd> | |
| 170 tuple of (str, str, str, str, bool) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a> | |
| 174 <h4>GitSubmoduleAddDialog.on_submoduleDirButton_clicked</h4> | |
| 175 <b>on_submoduleDirButton_clicked</b>(<i></i>) | |
| 176 | |
| 177 <p> | |
| 178 Private slot to display a directory selection dialog. | |
| 179 </p> | |
| 180 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a> | |
| 181 <h4>GitSubmoduleAddDialog.on_submoduleUrlButton_clicked</h4> | |
| 182 <b>on_submoduleUrlButton_clicked</b>(<i></i>) | |
| 183 | |
| 184 <p> | |
| 185 Private slot to display a directory selection dialog. | |
| 186 </p> | |
| 187 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a> | |
| 188 <h4>GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked</h4> | |
| 189 <b>on_submoduleUrlClearHistoryButton_clicked</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Private slot to clear the history of entered repository URLs. | |
| 193 </p> | |
| 194 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a> | |
| 195 <h4>GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged</h4> | |
| 196 <b>on_submoduleUrlCombo_editTextChanged</b>(<i>txt</i>) | |
| 197 | |
| 198 <p> | |
| 199 Private slot to handle changes of the submodule repository URL. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>txt</i> (str)</dt> | |
| 204 <dd> | |
| 205 current text of the combo box | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /> | |
| 210 </body></html> |
