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 6942
- 2602857055c5
- parent 6020
- baf6da1ae288
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the data to add a submodule. | |
| 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="#GitSubmoduleAddDialog">GitSubmoduleAddDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter the data to add a submodule.</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="GitSubmoduleAddDialog" ID="GitSubmoduleAddDialog"></a> | |
| 43 <h2>GitSubmoduleAddDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter the data to add a submodule. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_GitSubmoduleAddDialog | |
| 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="#GitSubmoduleAddDialog.__init__">GitSubmoduleAddDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#GitSubmoduleAddDialog.__getRelativePath">__getRelativePath</a></td> | |
| 64 <td>Private method to convert a file path to a relative path.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#GitSubmoduleAddDialog.__saveHistory">__saveHistory</a></td> | |
| 67 <td>Private method to save the repository URL history.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#GitSubmoduleAddDialog.getData">getData</a></td> | |
| 70 <td>Public method to get the entered data.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#GitSubmoduleAddDialog.on_submoduleDirButton_clicked">on_submoduleDirButton_clicked</a></td> | |
| 73 <td>Private slot to display a directory selection dialog.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlButton_clicked">on_submoduleUrlButton_clicked</a></td> | |
| 76 <td>Private slot to display a directory selection dialog.</td> | |
| 77 </tr><tr> | |
| 78 <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> | |
| 80 </tr><tr> | |
| 81 <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> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="GitSubmoduleAddDialog.__init__" ID="GitSubmoduleAddDialog.__init__"></a> | |
| 90 <h4>GitSubmoduleAddDialog (Constructor)</h4> | |
| 91 <b>GitSubmoduleAddDialog</b>(<i>vcs, repodir, parent=None</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>vcs</i> (Git)</dt> | |
| 96 <dd> | |
| 97 reference to the version control object | |
| 98 </dd><dt><i>repodir</i> (str)</dt> | |
| 99 <dd> | |
| 100 directory containing the superproject | |
| 101 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 102 <dd> | |
| 103 reference to the parent widget | |
| 104 </dd> | |
| 105 </dl><a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a> | |
| 106 <h4>GitSubmoduleAddDialog.__getRelativePath</h4> | |
| 107 <b>__getRelativePath</b>(<i>path</i>) | |
| 108 <p> | |
| 109 Private method to convert a file path to a relative path. | |
| 110 </p><dl> | |
| 111 <dt><i>path</i> (str)</dt> | |
| 112 <dd> | |
| 113 file or directory name to convert | |
| 114 </dd> | |
| 115 </dl><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 relative path or unchanged path, if path doesn't | |
| 119 belong to the project | |
| 120 </dd> | |
| 121 </dl><dl> | |
| 122 <dt>Return Type:</dt> | |
| 123 <dd> | |
| 124 str | |
| 125 </dd> | |
| 126 </dl><a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a> | |
| 127 <h4>GitSubmoduleAddDialog.__saveHistory</h4> | |
| 128 <b>__saveHistory</b>(<i></i>) | |
| 129 <p> | |
| 130 Private method to save the repository URL history. | |
| 131 </p><a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a> | |
| 132 <h4>GitSubmoduleAddDialog.getData</h4> | |
| 133 <b>getData</b>(<i></i>) | |
| 134 <p> | |
| 135 Public method to get the entered data. | |
| 136 </p><dl> | |
| 137 <dt>Returns:</dt> | |
| 138 <dd> | |
| 139 tuple containing the repository URL, optional branch name, | |
| 140 optional logical name, optional submodule path and a flag | |
| 141 indicating to enforce the operation | |
| 142 </dd> | |
| 143 </dl><dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 tuple of (str, str, str, str, bool) | |
| 147 </dd> | |
| 148 </dl><a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a> | |
| 149 <h4>GitSubmoduleAddDialog.on_submoduleDirButton_clicked</h4> | |
| 150 <b>on_submoduleDirButton_clicked</b>(<i></i>) | |
| 151 <p> | |
| 152 Private slot to display a directory selection dialog. | |
| 153 </p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a> | |
| 154 <h4>GitSubmoduleAddDialog.on_submoduleUrlButton_clicked</h4> | |
| 155 <b>on_submoduleUrlButton_clicked</b>(<i></i>) | |
| 156 <p> | |
| 157 Private slot to display a directory selection dialog. | |
| 158 </p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a> | |
| 159 <h4>GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked</h4> | |
| 160 <b>on_submoduleUrlClearHistoryButton_clicked</b>(<i></i>) | |
| 161 <p> | |
| 162 Private slot to clear the history of entered repository URLs. | |
| 163 </p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a> | |
| 164 <h4>GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged</h4> | |
| 165 <b>on_submoduleUrlCombo_editTextChanged</b>(<i>txt</i>) | |
| 166 <p> | |
| 167 Private slot to handle changes of the submodule repository URL. | |
| 168 </p><dl> | |
| 169 <dt><i>txt</i> (str)</dt> | |
| 170 <dd> | |
| 171 current text of the combo box | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <div align="right"><a href="#top">Up</a></div> | |
| 175 <hr /> | |
| 176 </body></html> |
