src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter the data to add a submodule. 11 Module implementing a dialog to enter the data to add a submodule.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitSubmoduleAddDialog">GitSubmoduleAddDialog</a></td> 22 <td><a href="#GitSubmoduleAddDialog">GitSubmoduleAddDialog</a></td>
25 <td>Class implementing a dialog to enter the data to add a submodule.</td> 23 <td>Class implementing a dialog to enter the data to add a submodule.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitSubmoduleAddDialog" ID="GitSubmoduleAddDialog"></a> 34 <a NAME="GitSubmoduleAddDialog" ID="GitSubmoduleAddDialog"></a>
36 <h2>GitSubmoduleAddDialog</h2> 35 <h2>GitSubmoduleAddDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter the data to add a submodule. 37 Class implementing a dialog to enter the data to add a submodule.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_GitSubmoduleAddDialog 41 QDialog, Ui_GitSubmoduleAddDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#GitSubmoduleAddDialog.__init__">GitSubmoduleAddDialog</a></td> 55 <td><a href="#GitSubmoduleAddDialog.__init__">GitSubmoduleAddDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
85 <tr> 82 <tr>
86 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged">on_submoduleUrlCombo_editTextChanged</a></td> 83 <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> 84 <td>Private slot to handle changes of the submodule repository URL.</td>
88 </tr> 85 </tr>
89 </table> 86 </table>
87
90 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
91 89 <table>
92 <table> 90 <tr><td>None</td></tr>
93 <tr><td>None</td></tr> 91 </table>
94 </table> 92
95 93
96 <a NAME="GitSubmoduleAddDialog.__init__" ID="GitSubmoduleAddDialog.__init__"></a> 94 <a NAME="GitSubmoduleAddDialog.__init__" ID="GitSubmoduleAddDialog.__init__"></a>
97 <h4>GitSubmoduleAddDialog (Constructor)</h4> 95 <h4>GitSubmoduleAddDialog (Constructor)</h4>
98 <b>GitSubmoduleAddDialog</b>(<i>vcs, repodir, parent=None</i>) 96 <b>GitSubmoduleAddDialog</b>(<i>vcs, repodir, parent=None</i>)
99
100 <p> 97 <p>
101 Constructor 98 Constructor
102 </p> 99 </p>
100
103 <dl> 101 <dl>
104 102
105 <dt><i>vcs</i> (Git)</dt> 103 <dt><i>vcs</i> (Git)</dt>
106 <dd> 104 <dd>
107 reference to the version control object 105 reference to the version control object
116 </dd> 114 </dd>
117 </dl> 115 </dl>
118 <a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a> 116 <a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a>
119 <h4>GitSubmoduleAddDialog.__getRelativePath</h4> 117 <h4>GitSubmoduleAddDialog.__getRelativePath</h4>
120 <b>__getRelativePath</b>(<i>path</i>) 118 <b>__getRelativePath</b>(<i>path</i>)
121
122 <p> 119 <p>
123 Private method to convert a file path to a relative path. 120 Private method to convert a file path to a relative path.
124 </p> 121 </p>
122
125 <dl> 123 <dl>
126 124
127 <dt><i>path</i> (str)</dt> 125 <dt><i>path</i> (str)</dt>
128 <dd> 126 <dd>
129 file or directory name to convert 127 file or directory name to convert
143 </dd> 141 </dd>
144 </dl> 142 </dl>
145 <a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a> 143 <a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a>
146 <h4>GitSubmoduleAddDialog.__saveHistory</h4> 144 <h4>GitSubmoduleAddDialog.__saveHistory</h4>
147 <b>__saveHistory</b>(<i></i>) 145 <b>__saveHistory</b>(<i></i>)
148
149 <p> 146 <p>
150 Private method to save the repository URL history. 147 Private method to save the repository URL history.
151 </p> 148 </p>
149
152 <a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a> 150 <a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a>
153 <h4>GitSubmoduleAddDialog.getData</h4> 151 <h4>GitSubmoduleAddDialog.getData</h4>
154 <b>getData</b>(<i></i>) 152 <b>getData</b>(<i></i>)
155
156 <p> 153 <p>
157 Public method to get the entered data. 154 Public method to get the entered data.
158 </p> 155 </p>
156
159 <dl> 157 <dl>
160 <dt>Return:</dt> 158 <dt>Return:</dt>
161 <dd> 159 <dd>
162 tuple containing the repository URL, optional branch name, 160 tuple containing the repository URL, optional branch name,
163 optional logical name, optional submodule path and a flag 161 optional logical name, optional submodule path and a flag
171 </dd> 169 </dd>
172 </dl> 170 </dl>
173 <a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a> 171 <a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a>
174 <h4>GitSubmoduleAddDialog.on_submoduleDirButton_clicked</h4> 172 <h4>GitSubmoduleAddDialog.on_submoduleDirButton_clicked</h4>
175 <b>on_submoduleDirButton_clicked</b>(<i></i>) 173 <b>on_submoduleDirButton_clicked</b>(<i></i>)
176
177 <p> 174 <p>
178 Private slot to display a directory selection dialog. 175 Private slot to display a directory selection dialog.
179 </p> 176 </p>
177
180 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a> 178 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a>
181 <h4>GitSubmoduleAddDialog.on_submoduleUrlButton_clicked</h4> 179 <h4>GitSubmoduleAddDialog.on_submoduleUrlButton_clicked</h4>
182 <b>on_submoduleUrlButton_clicked</b>(<i></i>) 180 <b>on_submoduleUrlButton_clicked</b>(<i></i>)
183
184 <p> 181 <p>
185 Private slot to display a directory selection dialog. 182 Private slot to display a directory selection dialog.
186 </p> 183 </p>
184
187 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a> 185 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a>
188 <h4>GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked</h4> 186 <h4>GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked</h4>
189 <b>on_submoduleUrlClearHistoryButton_clicked</b>(<i></i>) 187 <b>on_submoduleUrlClearHistoryButton_clicked</b>(<i></i>)
190
191 <p> 188 <p>
192 Private slot to clear the history of entered repository URLs. 189 Private slot to clear the history of entered repository URLs.
193 </p> 190 </p>
191
194 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a> 192 <a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a>
195 <h4>GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged</h4> 193 <h4>GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged</h4>
196 <b>on_submoduleUrlCombo_editTextChanged</b>(<i>txt</i>) 194 <b>on_submoduleUrlCombo_editTextChanged</b>(<i>txt</i>)
197
198 <p> 195 <p>
199 Private slot to handle changes of the submodule repository URL. 196 Private slot to handle changes of the submodule repository URL.
200 </p> 197 </p>
198
201 <dl> 199 <dl>
202 200
203 <dt><i>txt</i> (str)</dt> 201 <dt><i>txt</i> (str)</dt>
204 <dd> 202 <dd>
205 current text of the combo box 203 current text of the combo box

eric ide

mercurial