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