Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
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.GitCommitDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitCommitDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to enter the commit message. 26 Module implementing a dialog to enter the commit message.
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="#GitCommitDialog">GitCommitDialog</a></td> 38 <td><a href="#GitCommitDialog">GitCommitDialog</a></td>
34 <td>Class implementing a dialog to enter the commit message.</td> 39 <td>Class implementing a dialog to enter the commit message.</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="GitCommitDialog" ID="GitCommitDialog"></a> 49 <a NAME="GitCommitDialog" ID="GitCommitDialog"></a>
43 <h2>GitCommitDialog</h2> 50 <h2>GitCommitDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to enter the commit message. 53 Class implementing a dialog to enter the commit message.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>accepted()</dt> 58 <dt>accepted()</dt>
49 <dd> 59 <dd>
50 emitted, if the dialog was accepted 60 emitted, if the dialog was accepted
51 </dd><dt>rejected()</dt> 61 </dd>
62 <dt>rejected()</dt>
52 <dd> 63 <dd>
53 emitted, if the dialog was rejected 64 emitted, if the dialog was rejected
54 </dd> 65 </dd>
55 </dl> 66 </dl>
56 <h3>Derived from</h3> 67 <h3>Derived from</h3>
57 QWidget, Ui_GitCommitDialog 68 QWidget, Ui_GitCommitDialog
58 <h3>Class Attributes</h3> 69 <h3>Class Attributes</h3>
70
59 <table> 71 <table>
60 <tr><td>None</td></tr> 72 <tr><td>None</td></tr>
61 </table> 73 </table>
62 <h3>Class Methods</h3> 74 <h3>Class Methods</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Methods</h3> 79 <h3>Methods</h3>
67 <table> 80
81 <table>
82
68 <tr> 83 <tr>
69 <td><a href="#GitCommitDialog.__init__">GitCommitDialog</a></td> 84 <td><a href="#GitCommitDialog.__init__">GitCommitDialog</a></td>
70 <td>Constructor</td> 85 <td>Constructor</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#GitCommitDialog.amend">amend</a></td> 88 <td><a href="#GitCommitDialog.amend">amend</a></td>
73 <td>Public method to retrieve the state of the amend flag.</td> 89 <td>Public method to retrieve the state of the amend flag.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#GitCommitDialog.logMessage">logMessage</a></td> 92 <td><a href="#GitCommitDialog.logMessage">logMessage</a></td>
76 <td>Public method to retrieve the log message.</td> 93 <td>Public method to retrieve the log message.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#GitCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> 96 <td><a href="#GitCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
79 <td>Private slot called by the buttonBox accepted signal.</td> 97 <td>Private slot called by the buttonBox accepted signal.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#GitCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 100 <td><a href="#GitCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
82 <td>Private slot called by a button of the button box clicked.</td> 101 <td>Private slot called by a button of the button box clicked.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#GitCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> 104 <td><a href="#GitCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
85 <td>Private slot called by the buttonBox rejected signal.</td> 105 <td>Private slot called by the buttonBox rejected signal.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#GitCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> 108 <td><a href="#GitCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
88 <td>Private slot to select a commit message from recent ones.</td> 109 <td>Private slot to select a commit message from recent ones.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#GitCommitDialog.resetAuthor">resetAuthor</a></td> 112 <td><a href="#GitCommitDialog.resetAuthor">resetAuthor</a></td>
91 <td>Public method to retrieve the state of the reset author flag.</td> 113 <td>Public method to retrieve the state of the reset author flag.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#GitCommitDialog.showEvent">showEvent</a></td> 116 <td><a href="#GitCommitDialog.showEvent">showEvent</a></td>
94 <td>Protected method called when the dialog is about to be shown.</td> 117 <td>Protected method called when the dialog is about to be shown.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#GitCommitDialog.stagedOnly">stagedOnly</a></td> 120 <td><a href="#GitCommitDialog.stagedOnly">stagedOnly</a></td>
97 <td>Public method to retrieve the state of the staged only flag.</td> 121 <td>Public method to retrieve the state of the staged only flag.</td>
98 </tr> 122 </tr>
99 </table> 123 </table>
100 <h3>Static Methods</h3> 124 <h3>Static Methods</h3>
101 <table> 125
102 <tr><td>None</td></tr> 126 <table>
103 </table> 127 <tr><td>None</td></tr>
128 </table>
129
104 <a NAME="GitCommitDialog.__init__" ID="GitCommitDialog.__init__"></a> 130 <a NAME="GitCommitDialog.__init__" ID="GitCommitDialog.__init__"></a>
105 <h4>GitCommitDialog (Constructor)</h4> 131 <h4>GitCommitDialog (Constructor)</h4>
106 <b>GitCommitDialog</b>(<i>vcs, msg, amend, commitAll, parent=None</i>) 132 <b>GitCommitDialog</b>(<i>vcs, msg, amend, commitAll, parent=None</i>)
133
107 <p> 134 <p>
108 Constructor 135 Constructor
109 </p><dl> 136 </p>
137 <dl>
138
110 <dt><i>vcs</i></dt> 139 <dt><i>vcs</i></dt>
111 <dd> 140 <dd>
112 reference to the vcs object 141 reference to the vcs object
113 </dd><dt><i>msg</i></dt> 142 </dd>
143 <dt><i>msg</i></dt>
114 <dd> 144 <dd>
115 initial message (string) 145 initial message (string)
116 </dd><dt><i>amend</i></dt> 146 </dd>
147 <dt><i>amend</i></dt>
117 <dd> 148 <dd>
118 flag indicating to amend the HEAD commit (boolean) 149 flag indicating to amend the HEAD commit (boolean)
119 </dd><dt><i>commitAll</i></dt> 150 </dd>
151 <dt><i>commitAll</i></dt>
120 <dd> 152 <dd>
121 flag indicating to commit all local changes (boolean) 153 flag indicating to commit all local changes (boolean)
122 </dd><dt><i>parent</i></dt> 154 </dd>
155 <dt><i>parent</i></dt>
123 <dd> 156 <dd>
124 parent widget (QWidget) 157 parent widget (QWidget)
125 </dd> 158 </dd>
126 </dl><a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a> 159 </dl>
160 <a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a>
127 <h4>GitCommitDialog.amend</h4> 161 <h4>GitCommitDialog.amend</h4>
128 <b>amend</b>(<i></i>) 162 <b>amend</b>(<i></i>)
163
129 <p> 164 <p>
130 Public method to retrieve the state of the amend flag. 165 Public method to retrieve the state of the amend flag.
131 </p><dl> 166 </p>
167 <dl>
132 <dt>Returns:</dt> 168 <dt>Returns:</dt>
133 <dd> 169 <dd>
134 state of the amend flag (boolean) 170 state of the amend flag (boolean)
135 </dd> 171 </dd>
136 </dl><a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a> 172 </dl>
173 <a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a>
137 <h4>GitCommitDialog.logMessage</h4> 174 <h4>GitCommitDialog.logMessage</h4>
138 <b>logMessage</b>(<i></i>) 175 <b>logMessage</b>(<i></i>)
176
139 <p> 177 <p>
140 Public method to retrieve the log message. 178 Public method to retrieve the log message.
141 </p><dl> 179 </p>
180 <dl>
142 <dt>Returns:</dt> 181 <dt>Returns:</dt>
143 <dd> 182 <dd>
144 the log message (string) 183 the log message (string)
145 </dd> 184 </dd>
146 </dl><a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a> 185 </dl>
186 <a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a>
147 <h4>GitCommitDialog.on_buttonBox_accepted</h4> 187 <h4>GitCommitDialog.on_buttonBox_accepted</h4>
148 <b>on_buttonBox_accepted</b>(<i></i>) 188 <b>on_buttonBox_accepted</b>(<i></i>)
189
149 <p> 190 <p>
150 Private slot called by the buttonBox accepted signal. 191 Private slot called by the buttonBox accepted signal.
151 </p><a NAME="GitCommitDialog.on_buttonBox_clicked" ID="GitCommitDialog.on_buttonBox_clicked"></a> 192 </p>
193 <a NAME="GitCommitDialog.on_buttonBox_clicked" ID="GitCommitDialog.on_buttonBox_clicked"></a>
152 <h4>GitCommitDialog.on_buttonBox_clicked</h4> 194 <h4>GitCommitDialog.on_buttonBox_clicked</h4>
153 <b>on_buttonBox_clicked</b>(<i>button</i>) 195 <b>on_buttonBox_clicked</b>(<i>button</i>)
196
154 <p> 197 <p>
155 Private slot called by a button of the button box clicked. 198 Private slot called by a button of the button box clicked.
156 </p><dl> 199 </p>
200 <dl>
201
157 <dt><i>button</i></dt> 202 <dt><i>button</i></dt>
158 <dd> 203 <dd>
159 button that was clicked (QAbstractButton) 204 button that was clicked (QAbstractButton)
160 </dd> 205 </dd>
161 </dl><a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a> 206 </dl>
207 <a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a>
162 <h4>GitCommitDialog.on_buttonBox_rejected</h4> 208 <h4>GitCommitDialog.on_buttonBox_rejected</h4>
163 <b>on_buttonBox_rejected</b>(<i></i>) 209 <b>on_buttonBox_rejected</b>(<i></i>)
210
164 <p> 211 <p>
165 Private slot called by the buttonBox rejected signal. 212 Private slot called by the buttonBox rejected signal.
166 </p><a NAME="GitCommitDialog.on_recentComboBox_activated" ID="GitCommitDialog.on_recentComboBox_activated"></a> 213 </p>
214 <a NAME="GitCommitDialog.on_recentComboBox_activated" ID="GitCommitDialog.on_recentComboBox_activated"></a>
167 <h4>GitCommitDialog.on_recentComboBox_activated</h4> 215 <h4>GitCommitDialog.on_recentComboBox_activated</h4>
168 <b>on_recentComboBox_activated</b>(<i>txt</i>) 216 <b>on_recentComboBox_activated</b>(<i>txt</i>)
217
169 <p> 218 <p>
170 Private slot to select a commit message from recent ones. 219 Private slot to select a commit message from recent ones.
171 </p><dl> 220 </p>
221 <dl>
222
172 <dt><i>txt</i></dt> 223 <dt><i>txt</i></dt>
173 <dd> 224 <dd>
174 text of the selected entry (string) 225 text of the selected entry (string)
175 </dd> 226 </dd>
176 </dl><a NAME="GitCommitDialog.resetAuthor" ID="GitCommitDialog.resetAuthor"></a> 227 </dl>
228 <a NAME="GitCommitDialog.resetAuthor" ID="GitCommitDialog.resetAuthor"></a>
177 <h4>GitCommitDialog.resetAuthor</h4> 229 <h4>GitCommitDialog.resetAuthor</h4>
178 <b>resetAuthor</b>(<i></i>) 230 <b>resetAuthor</b>(<i></i>)
231
179 <p> 232 <p>
180 Public method to retrieve the state of the reset author flag. 233 Public method to retrieve the state of the reset author flag.
181 </p><dl> 234 </p>
235 <dl>
182 <dt>Returns:</dt> 236 <dt>Returns:</dt>
183 <dd> 237 <dd>
184 state of the reset author flag (boolean) 238 state of the reset author flag (boolean)
185 </dd> 239 </dd>
186 </dl><a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a> 240 </dl>
241 <a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a>
187 <h4>GitCommitDialog.showEvent</h4> 242 <h4>GitCommitDialog.showEvent</h4>
188 <b>showEvent</b>(<i>evt</i>) 243 <b>showEvent</b>(<i>evt</i>)
244
189 <p> 245 <p>
190 Protected method called when the dialog is about to be shown. 246 Protected method called when the dialog is about to be shown.
191 </p><dl> 247 </p>
248 <dl>
249
192 <dt><i>evt</i></dt> 250 <dt><i>evt</i></dt>
193 <dd> 251 <dd>
194 the event (QShowEvent) 252 the event (QShowEvent)
195 </dd> 253 </dd>
196 </dl><a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a> 254 </dl>
255 <a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a>
197 <h4>GitCommitDialog.stagedOnly</h4> 256 <h4>GitCommitDialog.stagedOnly</h4>
198 <b>stagedOnly</b>(<i></i>) 257 <b>stagedOnly</b>(<i></i>)
258
199 <p> 259 <p>
200 Public method to retrieve the state of the staged only flag. 260 Public method to retrieve the state of the staged only flag.
201 </p><dl> 261 </p>
262 <dl>
202 <dt>Returns:</dt> 263 <dt>Returns:</dt>
203 <dd> 264 <dd>
204 state of the staged only flag (boolean) 265 state of the staged only flag (boolean)
205 </dd> 266 </dd>
206 </dl> 267 </dl>

Mercurial Repository: eric

eric ide

mercurial