Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog</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.GitTagBranchListDialog</h1>
23 <p>
24 Module implementing a dialog to show a list of tags or branches.
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="#GitTagBranchListDialog">GitTagBranchListDialog</a></td>
34 <td>Class implementing a dialog to show a list of tags or branches.</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="GitTagBranchListDialog" ID="GitTagBranchListDialog"></a>
43 <h2>GitTagBranchListDialog</h2>
44 <p>
45 Class implementing a dialog to show a list of tags or branches.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_GitTagBranchListDialog
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="#GitTagBranchListDialog.__init__">GitTagBranchListDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitTagBranchListDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><tr>
66 <td><a href="#GitTagBranchListDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a tag item in the tag list.</td>
68 </tr><tr>
69 <td><a href="#GitTagBranchListDialog.__getCommit">__getCommit</a></td>
70 <td>Private method to get the commit id for a tag.</td>
71 </tr><tr>
72 <td><a href="#GitTagBranchListDialog.__procFinished">__procFinished</a></td>
73 <td>Private slot connected to the finished signal.</td>
74 </tr><tr>
75 <td><a href="#GitTagBranchListDialog.__processOutputLine">__processOutputLine</a></td>
76 <td>Private method to process the lines of output.</td>
77 </tr><tr>
78 <td><a href="#GitTagBranchListDialog.__readStderr">__readStderr</a></td>
79 <td>Private slot to handle the readyReadStderr signal.</td>
80 </tr><tr>
81 <td><a href="#GitTagBranchListDialog.__readStdout">__readStdout</a></td>
82 <td>Private slot to handle the readyReadStdout signal.</td>
83 </tr><tr>
84 <td><a href="#GitTagBranchListDialog.__resizeColumns">__resizeColumns</a></td>
85 <td>Private method to resize the list columns.</td>
86 </tr><tr>
87 <td><a href="#GitTagBranchListDialog.__resort">__resort</a></td>
88 <td>Private method to resort the tree.</td>
89 </tr><tr>
90 <td><a href="#GitTagBranchListDialog.__showError">__showError</a></td>
91 <td>Private slot to show some error.</td>
92 </tr><tr>
93 <td><a href="#GitTagBranchListDialog.closeEvent">closeEvent</a></td>
94 <td>Protected slot implementing a close event handler.</td>
95 </tr><tr>
96 <td><a href="#GitTagBranchListDialog.keyPressEvent">keyPressEvent</a></td>
97 <td>Protected slot to handle a key press event.</td>
98 </tr><tr>
99 <td><a href="#GitTagBranchListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
100 <td>Private slot called by a button of the button box clicked.</td>
101 </tr><tr>
102 <td><a href="#GitTagBranchListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
103 <td>Private slot to handle the press of the return key in the input field.</td>
104 </tr><tr>
105 <td><a href="#GitTagBranchListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
106 <td>Private slot to handle the password checkbox toggled.</td>
107 </tr><tr>
108 <td><a href="#GitTagBranchListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
109 <td>Private slot to send the input to the git process.</td>
110 </tr><tr>
111 <td><a href="#GitTagBranchListDialog.start">start</a></td>
112 <td>Public slot to start the tag/branch list command.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="GitTagBranchListDialog.__init__" ID="GitTagBranchListDialog.__init__"></a>
120 <h4>GitTagBranchListDialog (Constructor)</h4>
121 <b>GitTagBranchListDialog</b>(<i>vcs, parent=None</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>vcs</i></dt>
126 <dd>
127 reference to the vcs object
128 </dd><dt><i>parent</i></dt>
129 <dd>
130 parent widget (QWidget)
131 </dd>
132 </dl><a NAME="GitTagBranchListDialog.__finish" ID="GitTagBranchListDialog.__finish"></a>
133 <h4>GitTagBranchListDialog.__finish</h4>
134 <b>__finish</b>(<i></i>)
135 <p>
136 Private slot called when the process finished or the user pressed
137 the button.
138 </p><a NAME="GitTagBranchListDialog.__generateItem" ID="GitTagBranchListDialog.__generateItem"></a>
139 <h4>GitTagBranchListDialog.__generateItem</h4>
140 <b>__generateItem</b>(<i>commit, name, msg="", bold=False, italic=False</i>)
141 <p>
142 Private method to generate a tag item in the tag list.
143 </p><dl>
144 <dt><i>commit</i></dt>
145 <dd>
146 commit id of the tag/branch (string)
147 </dd><dt><i>name</i></dt>
148 <dd>
149 name of the tag/branch (string)
150 </dd><dt><i>msg</i></dt>
151 <dd>
152 tag annotation message
153 </dd><dt><i>bold</i></dt>
154 <dd>
155 flag indicating to show the entry in bold (boolean)
156 </dd><dt><i>italic</i></dt>
157 <dd>
158 flag indicating to show the entry in italic (boolean)
159 </dd>
160 </dl><a NAME="GitTagBranchListDialog.__getCommit" ID="GitTagBranchListDialog.__getCommit"></a>
161 <h4>GitTagBranchListDialog.__getCommit</h4>
162 <b>__getCommit</b>(<i>tag</i>)
163 <p>
164 Private method to get the commit id for a tag.
165 </p><dl>
166 <dt><i>tag</i></dt>
167 <dd>
168 tag name (string)
169 </dd>
170 </dl><dl>
171 <dt>Returns:</dt>
172 <dd>
173 commit id shortened to 10 characters (string)
174 </dd>
175 </dl><a NAME="GitTagBranchListDialog.__procFinished" ID="GitTagBranchListDialog.__procFinished"></a>
176 <h4>GitTagBranchListDialog.__procFinished</h4>
177 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
178 <p>
179 Private slot connected to the finished signal.
180 </p><dl>
181 <dt><i>exitCode</i></dt>
182 <dd>
183 exit code of the process (integer)
184 </dd><dt><i>exitStatus</i></dt>
185 <dd>
186 exit status of the process (QProcess.ExitStatus)
187 </dd>
188 </dl><a NAME="GitTagBranchListDialog.__processOutputLine" ID="GitTagBranchListDialog.__processOutputLine"></a>
189 <h4>GitTagBranchListDialog.__processOutputLine</h4>
190 <b>__processOutputLine</b>(<i>line</i>)
191 <p>
192 Private method to process the lines of output.
193 </p><dl>
194 <dt><i>line</i></dt>
195 <dd>
196 output line to be processed (string)
197 </dd>
198 </dl><a NAME="GitTagBranchListDialog.__readStderr" ID="GitTagBranchListDialog.__readStderr"></a>
199 <h4>GitTagBranchListDialog.__readStderr</h4>
200 <b>__readStderr</b>(<i></i>)
201 <p>
202 Private slot to handle the readyReadStderr signal.
203 </p><p>
204 It reads the error output of the process and inserts it into the
205 error pane.
206 </p><a NAME="GitTagBranchListDialog.__readStdout" ID="GitTagBranchListDialog.__readStdout"></a>
207 <h4>GitTagBranchListDialog.__readStdout</h4>
208 <b>__readStdout</b>(<i></i>)
209 <p>
210 Private slot to handle the readyReadStdout signal.
211 </p><p>
212 It reads the output of the process, formats it and inserts it into
213 the contents pane.
214 </p><a NAME="GitTagBranchListDialog.__resizeColumns" ID="GitTagBranchListDialog.__resizeColumns"></a>
215 <h4>GitTagBranchListDialog.__resizeColumns</h4>
216 <b>__resizeColumns</b>(<i></i>)
217 <p>
218 Private method to resize the list columns.
219 </p><a NAME="GitTagBranchListDialog.__resort" ID="GitTagBranchListDialog.__resort"></a>
220 <h4>GitTagBranchListDialog.__resort</h4>
221 <b>__resort</b>(<i></i>)
222 <p>
223 Private method to resort the tree.
224 </p><a NAME="GitTagBranchListDialog.__showError" ID="GitTagBranchListDialog.__showError"></a>
225 <h4>GitTagBranchListDialog.__showError</h4>
226 <b>__showError</b>(<i>out</i>)
227 <p>
228 Private slot to show some error.
229 </p><dl>
230 <dt><i>out</i></dt>
231 <dd>
232 error to be shown (string)
233 </dd>
234 </dl><a NAME="GitTagBranchListDialog.closeEvent" ID="GitTagBranchListDialog.closeEvent"></a>
235 <h4>GitTagBranchListDialog.closeEvent</h4>
236 <b>closeEvent</b>(<i>e</i>)
237 <p>
238 Protected slot implementing a close event handler.
239 </p><dl>
240 <dt><i>e</i></dt>
241 <dd>
242 close event (QCloseEvent)
243 </dd>
244 </dl><a NAME="GitTagBranchListDialog.keyPressEvent" ID="GitTagBranchListDialog.keyPressEvent"></a>
245 <h4>GitTagBranchListDialog.keyPressEvent</h4>
246 <b>keyPressEvent</b>(<i>evt</i>)
247 <p>
248 Protected slot to handle a key press event.
249 </p><dl>
250 <dt><i>evt</i></dt>
251 <dd>
252 the key press event (QKeyEvent)
253 </dd>
254 </dl><a NAME="GitTagBranchListDialog.on_buttonBox_clicked" ID="GitTagBranchListDialog.on_buttonBox_clicked"></a>
255 <h4>GitTagBranchListDialog.on_buttonBox_clicked</h4>
256 <b>on_buttonBox_clicked</b>(<i>button</i>)
257 <p>
258 Private slot called by a button of the button box clicked.
259 </p><dl>
260 <dt><i>button</i></dt>
261 <dd>
262 button that was clicked (QAbstractButton)
263 </dd>
264 </dl><a NAME="GitTagBranchListDialog.on_input_returnPressed" ID="GitTagBranchListDialog.on_input_returnPressed"></a>
265 <h4>GitTagBranchListDialog.on_input_returnPressed</h4>
266 <b>on_input_returnPressed</b>(<i></i>)
267 <p>
268 Private slot to handle the press of the return key in the input field.
269 </p><a NAME="GitTagBranchListDialog.on_passwordCheckBox_toggled" ID="GitTagBranchListDialog.on_passwordCheckBox_toggled"></a>
270 <h4>GitTagBranchListDialog.on_passwordCheckBox_toggled</h4>
271 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
272 <p>
273 Private slot to handle the password checkbox toggled.
274 </p><dl>
275 <dt><i>isOn</i></dt>
276 <dd>
277 flag indicating the status of the check box (boolean)
278 </dd>
279 </dl><a NAME="GitTagBranchListDialog.on_sendButton_clicked" ID="GitTagBranchListDialog.on_sendButton_clicked"></a>
280 <h4>GitTagBranchListDialog.on_sendButton_clicked</h4>
281 <b>on_sendButton_clicked</b>(<i></i>)
282 <p>
283 Private slot to send the input to the git process.
284 </p><a NAME="GitTagBranchListDialog.start" ID="GitTagBranchListDialog.start"></a>
285 <h4>GitTagBranchListDialog.start</h4>
286 <b>start</b>(<i>path, tags, listAll=True, merged=True</i>)
287 <p>
288 Public slot to start the tag/branch list command.
289 </p><dl>
290 <dt><i>path</i></dt>
291 <dd>
292 name of directory to be listed (string)
293 </dd><dt><i>tags</i></dt>
294 <dd>
295 flag indicating a list of tags is requested
296 (False = branches, True = tags)
297 </dd><dt><i>listAll</i></dt>
298 <dd>
299 flag indicating to show all tags or branches (boolean)
300 </dd><dt><i>merged</i></dt>
301 <dd>
302 flag indicating to show only merged or non-merged
303 branches (boolean)
304 </dd>
305 </dl>
306 <div align="right"><a href="#top">Up</a></div>
307 <hr />
308 </body></html>

Mercurial Repository: eric

eric ide

mercurial