src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog.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.GitPullDialog</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.GitPullDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter data for a Pull 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="#GitPullDialog">GitPullDialog</a></td>
25 <td>Class implementing a dialog to enter data for a Pull 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="GitPullDialog" ID="GitPullDialog"></a>
36 <h2>GitPullDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter data for a Pull operation.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitPullDialog
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="#GitPullDialog.__init__">GitPullDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitPullDialog.__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="#GitPullDialog.__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="#GitPullDialog.getData">getData</a></td>
71 <td>Public method to get the entered data.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitPullDialog.on_remoteEdit_textChanged">on_remoteEdit_textChanged</a></td>
75 <td>Private slot to handle changes of the URL edit.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitPullDialog.on_remotesComboBox_currentTextChanged">on_remotesComboBox_currentTextChanged</a></td>
79 <td>Private slot to handle changes of the selected repository.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitPullDialog.on_updateButton_clicked">on_updateButton_clicked</a></td>
83 <td>Private slot to update the list of remote branches.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="GitPullDialog.__init__" ID="GitPullDialog.__init__"></a>
93 <h4>GitPullDialog (Constructor)</h4>
94 <b>GitPullDialog</b>(<i>vcs, repodir, parent=None</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>vcs</i></dt>
102 <dd>
103 reference to the git object
104 </dd>
105 <dt><i>repodir</i></dt>
106 <dd>
107 directory name of the local repository (string)
108 </dd>
109 <dt><i>parent</i></dt>
110 <dd>
111 reference to the parent widget (QWidget)
112 </dd>
113 </dl>
114 <a NAME="GitPullDialog.__okButtonEnable" ID="GitPullDialog.__okButtonEnable"></a>
115 <h4>GitPullDialog.__okButtonEnable</h4>
116 <b>__okButtonEnable</b>(<i></i>)
117
118 <p>
119 Private slot to set the enabled state of the OK button.
120 </p>
121 <a NAME="GitPullDialog.__updateButtonEnable" ID="GitPullDialog.__updateButtonEnable"></a>
122 <h4>GitPullDialog.__updateButtonEnable</h4>
123 <b>__updateButtonEnable</b>(<i></i>)
124
125 <p>
126 Private slot to set the enabled state of the update button.
127 </p>
128 <a NAME="GitPullDialog.getData" ID="GitPullDialog.getData"></a>
129 <h4>GitPullDialog.getData</h4>
130 <b>getData</b>(<i></i>)
131
132 <p>
133 Public method to get the entered data.
134 </p>
135 <dl>
136 <dt>Return:</dt>
137 <dd>
138 tuple of remote name, remote url (for custom remotes),
139 remote branches, a flag indicating to pull from all repositories
140 and a flag indicating to remove obsolete tracking references
141 (string, string, list of strings, boolean, boolean)
142 </dd>
143 </dl>
144 <a NAME="GitPullDialog.on_remoteEdit_textChanged" ID="GitPullDialog.on_remoteEdit_textChanged"></a>
145 <h4>GitPullDialog.on_remoteEdit_textChanged</h4>
146 <b>on_remoteEdit_textChanged</b>(<i>txt</i>)
147
148 <p>
149 Private slot to handle changes of the URL edit.
150 </p>
151 <dl>
152
153 <dt><i>txt</i></dt>
154 <dd>
155 current text of the URL edit (string)
156 </dd>
157 </dl>
158 <a NAME="GitPullDialog.on_remotesComboBox_currentTextChanged" ID="GitPullDialog.on_remotesComboBox_currentTextChanged"></a>
159 <h4>GitPullDialog.on_remotesComboBox_currentTextChanged</h4>
160 <b>on_remotesComboBox_currentTextChanged</b>(<i>txt</i>)
161
162 <p>
163 Private slot to handle changes of the selected repository.
164 </p>
165 <dl>
166
167 <dt><i>txt</i></dt>
168 <dd>
169 current text of the combo box (string)
170 </dd>
171 </dl>
172 <a NAME="GitPullDialog.on_updateButton_clicked" ID="GitPullDialog.on_updateButton_clicked"></a>
173 <h4>GitPullDialog.on_updateButton_clicked</h4>
174 <b>on_updateButton_clicked</b>(<i></i>)
175
176 <p>
177 Private slot to update the list of remote branches.
178 </p>
179 <div align="right"><a href="#top">Up</a></div>
180 <hr />
181 </body></html>

eric ide

mercurial