Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show the results of the git describe action. 26 Module implementing a dialog to show the results of the git describe action.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#GitDescribeDialog">GitDescribeDialog</a></td> 38 <td><a href="#GitDescribeDialog">GitDescribeDialog</a></td>
34 <td>Class implementing a dialog to show the results of the git describe action.</td> 39 <td>Class implementing a dialog to show the results of the git describe action.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="GitDescribeDialog" ID="GitDescribeDialog"></a> 49 <a NAME="GitDescribeDialog" ID="GitDescribeDialog"></a>
43 <h2>GitDescribeDialog</h2> 50 <h2>GitDescribeDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show the results of the git describe action. 53 Class implementing a dialog to show the results of the git describe action.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_GitDescribeDialog 56 QDialog, Ui_GitDescribeDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#GitDescribeDialog.__init__">GitDescribeDialog</a></td> 72 <td><a href="#GitDescribeDialog.__init__">GitDescribeDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#GitDescribeDialog.__finish">__finish</a></td> 76 <td><a href="#GitDescribeDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td> 77 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#GitDescribeDialog.__procFinished">__procFinished</a></td> 80 <td><a href="#GitDescribeDialog.__procFinished">__procFinished</a></td>
67 <td>Private slot connected to the finished signal.</td> 81 <td>Private slot connected to the finished signal.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#GitDescribeDialog.__readStderr">__readStderr</a></td> 84 <td><a href="#GitDescribeDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStderr signal.</td> 85 <td>Private slot to handle the readyReadStderr signal.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#GitDescribeDialog.__readStdout">__readStdout</a></td> 88 <td><a href="#GitDescribeDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStdout signal.</td> 89 <td>Private slot to handle the readyReadStdout signal.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#GitDescribeDialog.__resizeColumns">__resizeColumns</a></td> 92 <td><a href="#GitDescribeDialog.__resizeColumns">__resizeColumns</a></td>
76 <td>Private method to resize the list columns.</td> 93 <td>Private method to resize the list columns.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#GitDescribeDialog.__resort">__resort</a></td> 96 <td><a href="#GitDescribeDialog.__resort">__resort</a></td>
79 <td>Private method to resort the tree.</td> 97 <td>Private method to resort the tree.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#GitDescribeDialog.closeEvent">closeEvent</a></td> 100 <td><a href="#GitDescribeDialog.closeEvent">closeEvent</a></td>
82 <td>Protected slot implementing a close event handler.</td> 101 <td>Protected slot implementing a close event handler.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#GitDescribeDialog.keyPressEvent">keyPressEvent</a></td> 104 <td><a href="#GitDescribeDialog.keyPressEvent">keyPressEvent</a></td>
85 <td>Protected slot to handle a key press event.</td> 105 <td>Protected slot to handle a key press event.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#GitDescribeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 108 <td><a href="#GitDescribeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
88 <td>Private slot called by a button of the button box clicked.</td> 109 <td>Private slot called by a button of the button box clicked.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#GitDescribeDialog.on_input_returnPressed">on_input_returnPressed</a></td> 112 <td><a href="#GitDescribeDialog.on_input_returnPressed">on_input_returnPressed</a></td>
91 <td>Private slot to handle the press of the return key in the input field.</td> 113 <td>Private slot to handle the press of the return key in the input field.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#GitDescribeDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> 116 <td><a href="#GitDescribeDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
94 <td>Private slot to handle the password checkbox toggled.</td> 117 <td>Private slot to handle the password checkbox toggled.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#GitDescribeDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> 120 <td><a href="#GitDescribeDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
97 <td>Private slot to send the input to the git process.</td> 121 <td>Private slot to send the input to the git process.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#GitDescribeDialog.start">start</a></td> 124 <td><a href="#GitDescribeDialog.start">start</a></td>
100 <td>Public slot to start the tag/branch list command.</td> 125 <td>Public slot to start the tag/branch list command.</td>
101 </tr> 126 </tr>
102 </table> 127 </table>
103 <h3>Static Methods</h3> 128 <h3>Static Methods</h3>
104 <table> 129
105 <tr><td>None</td></tr> 130 <table>
106 </table> 131 <tr><td>None</td></tr>
132 </table>
133
107 <a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a> 134 <a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a>
108 <h4>GitDescribeDialog (Constructor)</h4> 135 <h4>GitDescribeDialog (Constructor)</h4>
109 <b>GitDescribeDialog</b>(<i>vcs, parent=None</i>) 136 <b>GitDescribeDialog</b>(<i>vcs, parent=None</i>)
137
110 <p> 138 <p>
111 Constructor 139 Constructor
112 </p><dl> 140 </p>
141 <dl>
142
113 <dt><i>vcs</i></dt> 143 <dt><i>vcs</i></dt>
114 <dd> 144 <dd>
115 reference to the vcs object 145 reference to the vcs object
116 </dd><dt><i>parent</i></dt> 146 </dd>
147 <dt><i>parent</i></dt>
117 <dd> 148 <dd>
118 reference to the parent widget (QWidget) 149 reference to the parent widget (QWidget)
119 </dd> 150 </dd>
120 </dl><a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a> 151 </dl>
152 <a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a>
121 <h4>GitDescribeDialog.__finish</h4> 153 <h4>GitDescribeDialog.__finish</h4>
122 <b>__finish</b>(<i></i>) 154 <b>__finish</b>(<i></i>)
155
123 <p> 156 <p>
124 Private slot called when the process finished or the user pressed 157 Private slot called when the process finished or the user pressed
125 the button. 158 the button.
126 </p><a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a> 159 </p>
160 <a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a>
127 <h4>GitDescribeDialog.__procFinished</h4> 161 <h4>GitDescribeDialog.__procFinished</h4>
128 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 162 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
163
129 <p> 164 <p>
130 Private slot connected to the finished signal. 165 Private slot connected to the finished signal.
131 </p><dl> 166 </p>
167 <dl>
168
132 <dt><i>exitCode</i></dt> 169 <dt><i>exitCode</i></dt>
133 <dd> 170 <dd>
134 exit code of the process (integer) 171 exit code of the process (integer)
135 </dd><dt><i>exitStatus</i></dt> 172 </dd>
173 <dt><i>exitStatus</i></dt>
136 <dd> 174 <dd>
137 exit status of the process (QProcess.ExitStatus) 175 exit status of the process (QProcess.ExitStatus)
138 </dd> 176 </dd>
139 </dl><a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a> 177 </dl>
178 <a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a>
140 <h4>GitDescribeDialog.__readStderr</h4> 179 <h4>GitDescribeDialog.__readStderr</h4>
141 <b>__readStderr</b>(<i></i>) 180 <b>__readStderr</b>(<i></i>)
181
142 <p> 182 <p>
143 Private slot to handle the readyReadStderr signal. 183 Private slot to handle the readyReadStderr signal.
144 </p><p> 184 </p>
185 <p>
145 It reads the error output of the process and inserts it into the 186 It reads the error output of the process and inserts it into the
146 error pane. 187 error pane.
147 </p><a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a> 188 </p>
189 <a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a>
148 <h4>GitDescribeDialog.__readStdout</h4> 190 <h4>GitDescribeDialog.__readStdout</h4>
149 <b>__readStdout</b>(<i></i>) 191 <b>__readStdout</b>(<i></i>)
192
150 <p> 193 <p>
151 Private slot to handle the readyReadStdout signal. 194 Private slot to handle the readyReadStdout signal.
152 </p><p> 195 </p>
196 <p>
153 It reads the output of the process, formats it and inserts it into 197 It reads the output of the process, formats it and inserts it into
154 the contents pane. 198 the contents pane.
155 </p><a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a> 199 </p>
200 <a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a>
156 <h4>GitDescribeDialog.__resizeColumns</h4> 201 <h4>GitDescribeDialog.__resizeColumns</h4>
157 <b>__resizeColumns</b>(<i></i>) 202 <b>__resizeColumns</b>(<i></i>)
203
158 <p> 204 <p>
159 Private method to resize the list columns. 205 Private method to resize the list columns.
160 </p><a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a> 206 </p>
207 <a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a>
161 <h4>GitDescribeDialog.__resort</h4> 208 <h4>GitDescribeDialog.__resort</h4>
162 <b>__resort</b>(<i></i>) 209 <b>__resort</b>(<i></i>)
210
163 <p> 211 <p>
164 Private method to resort the tree. 212 Private method to resort the tree.
165 </p><a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a> 213 </p>
214 <a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a>
166 <h4>GitDescribeDialog.closeEvent</h4> 215 <h4>GitDescribeDialog.closeEvent</h4>
167 <b>closeEvent</b>(<i>e</i>) 216 <b>closeEvent</b>(<i>e</i>)
217
168 <p> 218 <p>
169 Protected slot implementing a close event handler. 219 Protected slot implementing a close event handler.
170 </p><dl> 220 </p>
221 <dl>
222
171 <dt><i>e</i></dt> 223 <dt><i>e</i></dt>
172 <dd> 224 <dd>
173 close event (QCloseEvent) 225 close event (QCloseEvent)
174 </dd> 226 </dd>
175 </dl><a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a> 227 </dl>
228 <a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a>
176 <h4>GitDescribeDialog.keyPressEvent</h4> 229 <h4>GitDescribeDialog.keyPressEvent</h4>
177 <b>keyPressEvent</b>(<i>evt</i>) 230 <b>keyPressEvent</b>(<i>evt</i>)
231
178 <p> 232 <p>
179 Protected slot to handle a key press event. 233 Protected slot to handle a key press event.
180 </p><dl> 234 </p>
235 <dl>
236
181 <dt><i>evt</i></dt> 237 <dt><i>evt</i></dt>
182 <dd> 238 <dd>
183 the key press event (QKeyEvent) 239 the key press event (QKeyEvent)
184 </dd> 240 </dd>
185 </dl><a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a> 241 </dl>
242 <a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a>
186 <h4>GitDescribeDialog.on_buttonBox_clicked</h4> 243 <h4>GitDescribeDialog.on_buttonBox_clicked</h4>
187 <b>on_buttonBox_clicked</b>(<i>button</i>) 244 <b>on_buttonBox_clicked</b>(<i>button</i>)
245
188 <p> 246 <p>
189 Private slot called by a button of the button box clicked. 247 Private slot called by a button of the button box clicked.
190 </p><dl> 248 </p>
249 <dl>
250
191 <dt><i>button</i></dt> 251 <dt><i>button</i></dt>
192 <dd> 252 <dd>
193 button that was clicked (QAbstractButton) 253 button that was clicked (QAbstractButton)
194 </dd> 254 </dd>
195 </dl><a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a> 255 </dl>
256 <a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a>
196 <h4>GitDescribeDialog.on_input_returnPressed</h4> 257 <h4>GitDescribeDialog.on_input_returnPressed</h4>
197 <b>on_input_returnPressed</b>(<i></i>) 258 <b>on_input_returnPressed</b>(<i></i>)
259
198 <p> 260 <p>
199 Private slot to handle the press of the return key in the input field. 261 Private slot to handle the press of the return key in the input field.
200 </p><a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a> 262 </p>
263 <a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a>
201 <h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4> 264 <h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4>
202 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 265 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
266
203 <p> 267 <p>
204 Private slot to handle the password checkbox toggled. 268 Private slot to handle the password checkbox toggled.
205 </p><dl> 269 </p>
270 <dl>
271
206 <dt><i>isOn</i></dt> 272 <dt><i>isOn</i></dt>
207 <dd> 273 <dd>
208 flag indicating the status of the check box (boolean) 274 flag indicating the status of the check box (boolean)
209 </dd> 275 </dd>
210 </dl><a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a> 276 </dl>
277 <a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a>
211 <h4>GitDescribeDialog.on_sendButton_clicked</h4> 278 <h4>GitDescribeDialog.on_sendButton_clicked</h4>
212 <b>on_sendButton_clicked</b>(<i></i>) 279 <b>on_sendButton_clicked</b>(<i></i>)
280
213 <p> 281 <p>
214 Private slot to send the input to the git process. 282 Private slot to send the input to the git process.
215 </p><a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a> 283 </p>
284 <a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a>
216 <h4>GitDescribeDialog.start</h4> 285 <h4>GitDescribeDialog.start</h4>
217 <b>start</b>(<i>path, commits</i>) 286 <b>start</b>(<i>path, commits</i>)
287
218 <p> 288 <p>
219 Public slot to start the tag/branch list command. 289 Public slot to start the tag/branch list command.
220 </p><dl> 290 </p>
291 <dl>
292
221 <dt><i>path</i></dt> 293 <dt><i>path</i></dt>
222 <dd> 294 <dd>
223 name of directory to be listed (string) 295 name of directory to be listed (string)
224 </dd><dt><i>commits</i></dt> 296 </dd>
297 <dt><i>commits</i></dt>
225 <dd> 298 <dd>
226 list of commits to be described (list of string) 299 list of commits to be described (list of string)
227 </dd> 300 </dd>
228 </dl> 301 </dl>
229 <div align="right"><a href="#top">Up</a></div> 302 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial