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