src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.HgUncommitDialog.html

branch
eric7
changeset 11084
adbb5d1944ea
equal deleted inserted replaced
11083:0ecbf7ebfc49 11084:adbb5d1944ea
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.HgUncommitDialog</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.vcsMercurial.UncommitExtension.HgUncommitDialog</h1>
10 <p>
11 Module implementing a dialog to enter the uncommit data.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#HgUncommitDialog">HgUncommitDialog</a></td>
23 <td>Class implementing a dialog to enter the uncommit data.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="HgUncommitDialog" ID="HgUncommitDialog"></a>
35 <h2>HgUncommitDialog</h2>
36 <p>
37 Class implementing a dialog to enter the uncommit data.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_HgUncommitDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#HgUncommitDialog.__init__">HgUncommitDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#HgUncommitDialog.getUncommitData">getUncommitData</a></td>
60 <td>Public method to retrieve the entered uncommit data.</td>
61 </tr>
62 <tr>
63 <td><a href="#HgUncommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
64 <td>Private slot to select a commit message from recent ones.</td>
65 </tr>
66 </table>
67
68 <h3>Static Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72
73
74 <a NAME="HgUncommitDialog.__init__" ID="HgUncommitDialog.__init__"></a>
75 <h4>HgUncommitDialog (Constructor)</h4>
76 <b>HgUncommitDialog</b>(<i>vcs, parent=None</i>)
77 <p>
78 Constructor
79 </p>
80
81 <dl>
82
83 <dt><i>vcs</i> (Hg)</dt>
84 <dd>
85 reference to the version control object
86 </dd>
87 <dt><i>parent</i> (QWidget (optional))</dt>
88 <dd>
89 reference to the parent widget (defaults to None)
90 </dd>
91 </dl>
92 <a NAME="HgUncommitDialog.getUncommitData" ID="HgUncommitDialog.getUncommitData"></a>
93 <h4>HgUncommitDialog.getUncommitData</h4>
94 <b>getUncommitData</b>(<i></i>)
95 <p>
96 Public method to retrieve the entered uncommit data.
97 </p>
98
99 <dl>
100 <dt>Return:</dt>
101 <dd>
102 tuple containing the commit message, a flag indicating to
103 allow an empty commit, a flag indicating to allow an uncommit
104 with outstanding changes, name of the author and date/time of
105 the commit
106 </dd>
107 </dl>
108 <dl>
109 <dt>Return Type:</dt>
110 <dd>
111 tuple of (str, bool, bool, str, str)
112 </dd>
113 </dl>
114 <a NAME="HgUncommitDialog.on_recentComboBox_activated" ID="HgUncommitDialog.on_recentComboBox_activated"></a>
115 <h4>HgUncommitDialog.on_recentComboBox_activated</h4>
116 <b>on_recentComboBox_activated</b>(<i>index</i>)
117 <p>
118 Private slot to select a commit message from recent ones.
119 </p>
120
121 <dl>
122
123 <dt><i>index</i> (int)</dt>
124 <dd>
125 index of the selected entry
126 </dd>
127 </dl>
128 <div align="right"><a href="#top">Up</a></div>
129 <hr />
130 </body></html>

eric ide

mercurial