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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitFetchDialog</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.GitFetchDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter data for a Fetch operation.
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="#GitFetchDialog">GitFetchDialog</a></td>
25 <td>Class implementing a dialog to enter data for a Fetch operation.</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="GitFetchDialog" ID="GitFetchDialog"></a>
36 <h2>GitFetchDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter data for a Fetch operation.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitFetchDialog
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="#GitFetchDialog.__init__">GitFetchDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitFetchDialog.__okButtonEnable">__okButtonEnable</a></td>
63 <td>Private slot to set the enabled state of the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitFetchDialog.__updateButtonEnable">__updateButtonEnable</a></td>
67 <td>Private slot to set the enabled state of the update button.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitFetchDialog.getData">getData</a></td>
71 <td>Public method to get the entered data.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitFetchDialog.on_remoteBranchesList_itemSelectionChanged">on_remoteBranchesList_itemSelectionChanged</a></td>
75 <td>Private slot to handle a change of selected remote branches.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitFetchDialog.on_remoteEdit_textChanged">on_remoteEdit_textChanged</a></td>
79 <td>Private slot to handle changes of the URL edit.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitFetchDialog.on_remotesComboBox_currentTextChanged">on_remotesComboBox_currentTextChanged</a></td>
83 <td>Private slot to handle changes of the selected repository.</td>
84 </tr>
85 <tr>
86 <td><a href="#GitFetchDialog.on_updateButton_clicked">on_updateButton_clicked</a></td>
87 <td>Private slot to update the list of remote branches.</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="GitFetchDialog.__init__" ID="GitFetchDialog.__init__"></a>
97 <h4>GitFetchDialog (Constructor)</h4>
98 <b>GitFetchDialog</b>(<i>vcs, repodir, parent=None</i>)
99
100 <p>
101 Constructor
102 </p>
103 <dl>
104
105 <dt><i>vcs</i></dt>
106 <dd>
107 reference to the git object
108 </dd>
109 <dt><i>repodir</i></dt>
110 <dd>
111 directory name of the local repository (string)
112 </dd>
113 <dt><i>parent</i></dt>
114 <dd>
115 reference to the parent widget (QWidget)
116 </dd>
117 </dl>
118 <a NAME="GitFetchDialog.__okButtonEnable" ID="GitFetchDialog.__okButtonEnable"></a>
119 <h4>GitFetchDialog.__okButtonEnable</h4>
120 <b>__okButtonEnable</b>(<i></i>)
121
122 <p>
123 Private slot to set the enabled state of the OK button.
124 </p>
125 <a NAME="GitFetchDialog.__updateButtonEnable" ID="GitFetchDialog.__updateButtonEnable"></a>
126 <h4>GitFetchDialog.__updateButtonEnable</h4>
127 <b>__updateButtonEnable</b>(<i></i>)
128
129 <p>
130 Private slot to set the enabled state of the update button.
131 </p>
132 <a NAME="GitFetchDialog.getData" ID="GitFetchDialog.getData"></a>
133 <h4>GitFetchDialog.getData</h4>
134 <b>getData</b>(<i></i>)
135
136 <p>
137 Public method to get the entered data.
138 </p>
139 <dl>
140 <dt>Return:</dt>
141 <dd>
142 tuple of remote name, remote url (for custom remotes),
143 remote branches, local branch, a flag indicating to fetch from
144 all repositories, a flag indicating to remove obsolete tracking
145 references and a flag indicating to fetch tags as well
146 (string, string, list of strings, string, boolean, boolean,
147 boolean)
148 </dd>
149 </dl>
150 <a NAME="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged" ID="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged"></a>
151 <h4>GitFetchDialog.on_remoteBranchesList_itemSelectionChanged</h4>
152 <b>on_remoteBranchesList_itemSelectionChanged</b>(<i></i>)
153
154 <p>
155 Private slot to handle a change of selected remote branches.
156 </p>
157 <a NAME="GitFetchDialog.on_remoteEdit_textChanged" ID="GitFetchDialog.on_remoteEdit_textChanged"></a>
158 <h4>GitFetchDialog.on_remoteEdit_textChanged</h4>
159 <b>on_remoteEdit_textChanged</b>(<i>txt</i>)
160
161 <p>
162 Private slot to handle changes of the URL edit.
163 </p>
164 <dl>
165
166 <dt><i>txt</i></dt>
167 <dd>
168 current text of the URL edit (string)
169 </dd>
170 </dl>
171 <a NAME="GitFetchDialog.on_remotesComboBox_currentTextChanged" ID="GitFetchDialog.on_remotesComboBox_currentTextChanged"></a>
172 <h4>GitFetchDialog.on_remotesComboBox_currentTextChanged</h4>
173 <b>on_remotesComboBox_currentTextChanged</b>(<i>txt</i>)
174
175 <p>
176 Private slot to handle changes of the selected repository.
177 </p>
178 <dl>
179
180 <dt><i>txt</i></dt>
181 <dd>
182 current text of the combo box (string)
183 </dd>
184 </dl>
185 <a NAME="GitFetchDialog.on_updateButton_clicked" ID="GitFetchDialog.on_updateButton_clicked"></a>
186 <h4>GitFetchDialog.on_updateButton_clicked</h4>
187 <b>on_updateButton_clicked</b>(<i></i>)
188
189 <p>
190 Private slot to update the list of remote branches.
191 </p>
192 <div align="right"><a href="#top">Up</a></div>
193 <hr />
194 </body></html>

eric ide

mercurial