Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html

changeset 178
dd9f0bca5e2f
child 409
0ea528e80202
equal deleted inserted replaced
177:c822ccc4d138 178:dd9f0bca5e2f
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</h1>
24 <p>
25 Module implementing a dialog to enter the commit message.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HgCommitDialog">HgCommitDialog</a></td>
35 <td>Class implementing a dialog to enter the commit message.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="HgCommitDialog" ID="HgCommitDialog"></a>
44 <h2>HgCommitDialog</h2>
45 <p>
46 Class implementing a dialog to enter the commit message.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>accepted()</dt>
50 <dd>
51 emitted, if the dialog was accepted
52 </dd><dt>rejected()</dt>
53 <dd>
54 emitted, if the dialog was rejected
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QWidget, Ui_HgCommitDialog
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#HgCommitDialog.__init__">HgCommitDialog</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#HgCommitDialog.logMessage">logMessage</a></td>
70 <td>Public method to retrieve the log message.</td>
71 </tr><tr>
72 <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
73 <td>Private slot called by the buttonBox accepted signal.</td>
74 </tr><tr>
75 <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
76 <td>Private slot called by a button of the button box clicked.</td>
77 </tr><tr>
78 <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
79 <td>Private slot called by the buttonBox rejected signal.</td>
80 </tr><tr>
81 <td><a href="#HgCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
82 <td>Private slot to select a commit message from recent ones.</td>
83 </tr><tr>
84 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td>
85 <td>Public method called when the dialog is about to be shown.</td>
86 </tr>
87 </table>
88 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a>
89 <h4>HgCommitDialog (Constructor)</h4>
90 <b>HgCommitDialog</b>(<i>vcs, parent = None</i>)
91 <p>
92 Constructor
93 </p><dl>
94 <dt><i>vcs</i></dt>
95 <dd>
96 reference to the vcs object
97 </dd><dt><i>parent</i></dt>
98 <dd>
99 parent widget (QWidget)
100 </dd>
101 </dl><a NAME="HgCommitDialog.logMessage" ID="HgCommitDialog.logMessage"></a>
102 <h4>HgCommitDialog.logMessage</h4>
103 <b>logMessage</b>(<i></i>)
104 <p>
105 Public method to retrieve the log message.
106 </p><dl>
107 <dt>Returns:</dt>
108 <dd>
109 the log message (string)
110 </dd>
111 </dl><a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a>
112 <h4>HgCommitDialog.on_buttonBox_accepted</h4>
113 <b>on_buttonBox_accepted</b>(<i></i>)
114 <p>
115 Private slot called by the buttonBox accepted signal.
116 </p><a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a>
117 <h4>HgCommitDialog.on_buttonBox_clicked</h4>
118 <b>on_buttonBox_clicked</b>(<i>button</i>)
119 <p>
120 Private slot called by a button of the button box clicked.
121 </p><dl>
122 <dt><i>button</i></dt>
123 <dd>
124 button that was clicked (QAbstractButton)
125 </dd>
126 </dl><a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a>
127 <h4>HgCommitDialog.on_buttonBox_rejected</h4>
128 <b>on_buttonBox_rejected</b>(<i></i>)
129 <p>
130 Private slot called by the buttonBox rejected signal.
131 </p><a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a>
132 <h4>HgCommitDialog.on_recentComboBox_activated</h4>
133 <b>on_recentComboBox_activated</b>(<i>txt</i>)
134 <p>
135 Private slot to select a commit message from recent ones.
136 </p><a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a>
137 <h4>HgCommitDialog.showEvent</h4>
138 <b>showEvent</b>(<i>evt</i>)
139 <p>
140 Public method called when the dialog is about to be shown.
141 </p><dl>
142 <dt><i>evt</i></dt>
143 <dd>
144 the event (QShowEvent)
145 </dd>
146 </dl>
147 <div align="right"><a href="#top">Up</a></div>
148 <hr />
149 </body></html>

eric ide

mercurial