src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog</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.HgGraftDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the data for a graft session.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#HgGraftDialog">HgGraftDialog</a></td>
25 <td>Class implementing a dialog to enter the data for a graft session.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="HgGraftDialog" ID="HgGraftDialog"></a>
36 <h2>HgGraftDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the data for a graft session.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgGraftDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#HgGraftDialog.__init__">HgGraftDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgGraftDialog.__updateOk">__updateOk</a></td>
63 <td>Private slot to update the state of the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgGraftDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgGraftDialog.on_currentUserCheckBox_toggled">on_currentUserCheckBox_toggled</a></td>
71 <td>Private slot to handle changes of the current user state.</td>
72 </tr>
73 <tr>
74 <td><a href="#HgGraftDialog.on_revisionsEdit_textChanged">on_revisionsEdit_textChanged</a></td>
75 <td>Private slot to react upon changes of revisions.</td>
76 </tr>
77 <tr>
78 <td><a href="#HgGraftDialog.on_userEdit_textChanged">on_userEdit_textChanged</a></td>
79 <td>Private slot to handle changes of the user name.</td>
80 </tr>
81 <tr>
82 <td><a href="#HgGraftDialog.on_userGroup_toggled">on_userGroup_toggled</a></td>
83 <td>Private slot to handle changes of the user group state.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="HgGraftDialog.__init__" ID="HgGraftDialog.__init__"></a>
93 <h4>HgGraftDialog (Constructor)</h4>
94 <b>HgGraftDialog</b>(<i>vcs, revs=None, parent=None</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>vcs</i> (Hg)</dt>
102 <dd>
103 reference to the VCS object
104 </dd>
105 <dt><i>revs</i> (list of str)</dt>
106 <dd>
107 list of revisions to show in the revisions pane
108 </dd>
109 <dt><i>parent</i> (QWidget)</dt>
110 <dd>
111 reference to the parent widget
112 </dd>
113 </dl>
114 <a NAME="HgGraftDialog.__updateOk" ID="HgGraftDialog.__updateOk"></a>
115 <h4>HgGraftDialog.__updateOk</h4>
116 <b>__updateOk</b>(<i></i>)
117
118 <p>
119 Private slot to update the state of the OK button.
120 </p>
121 <a NAME="HgGraftDialog.getData" ID="HgGraftDialog.getData"></a>
122 <h4>HgGraftDialog.getData</h4>
123 <b>getData</b>(<i></i>)
124
125 <p>
126 Public method to retrieve the entered data.
127 </p>
128 <dl>
129 <dt>Return:</dt>
130 <dd>
131 tuple with list of revisions, a tuple giving a
132 flag indicating to set the user, a flag indicating to use the
133 current user and the user name, another tuple giving a flag
134 indicating to set the date, a flag indicating to use the
135 current date and the date, a flag indicating to append graft info
136 to the log message, a flag indicating a dry-run and a flag
137 indicating to not commit the copied changesets
138 </dd>
139 </dl>
140 <dl>
141 <dt>Return Type:</dt>
142 <dd>
143 tuple of (list of str, (bool, bool, str), (bool, bool, str),
144 bool, bool, bool)
145 </dd>
146 </dl>
147 <a NAME="HgGraftDialog.on_currentUserCheckBox_toggled" ID="HgGraftDialog.on_currentUserCheckBox_toggled"></a>
148 <h4>HgGraftDialog.on_currentUserCheckBox_toggled</h4>
149 <b>on_currentUserCheckBox_toggled</b>(<i>checked</i>)
150
151 <p>
152 Private slot to handle changes of the current user state.
153 </p>
154 <dl>
155
156 <dt><i>checked</i> (bool)</dt>
157 <dd>
158 flag giving the checked state
159 </dd>
160 </dl>
161 <a NAME="HgGraftDialog.on_revisionsEdit_textChanged" ID="HgGraftDialog.on_revisionsEdit_textChanged"></a>
162 <h4>HgGraftDialog.on_revisionsEdit_textChanged</h4>
163 <b>on_revisionsEdit_textChanged</b>(<i></i>)
164
165 <p>
166 Private slot to react upon changes of revisions.
167 </p>
168 <a NAME="HgGraftDialog.on_userEdit_textChanged" ID="HgGraftDialog.on_userEdit_textChanged"></a>
169 <h4>HgGraftDialog.on_userEdit_textChanged</h4>
170 <b>on_userEdit_textChanged</b>(<i>txt</i>)
171
172 <p>
173 Private slot to handle changes of the user name.
174 </p>
175 <dl>
176
177 <dt><i>txt</i></dt>
178 <dd>
179 text of the edit (string)
180 </dd>
181 </dl>
182 <a NAME="HgGraftDialog.on_userGroup_toggled" ID="HgGraftDialog.on_userGroup_toggled"></a>
183 <h4>HgGraftDialog.on_userGroup_toggled</h4>
184 <b>on_userGroup_toggled</b>(<i>checked</i>)
185
186 <p>
187 Private slot to handle changes of the user group state.
188 </p>
189 <dl>
190
191 <dt><i>checked</i> (bool)</dt>
192 <dd>
193 flag giving the checked state
194 </dd>
195 </dl>
196 <div align="right"><a href="#top">Up</a></div>
197 <hr />
198 </body></html>

eric ide

mercurial