Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.TransplantExtension.TransplantDialog.html

changeset 1078
aeee8401e2ce
child 1228
7afaf2fca55b
equal deleted inserted replaced
1076:6fb76985422b 1078:aeee8401e2ce
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.TransplantExtension.TransplantDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.TransplantExtension.TransplantDialog</h1>
24 <p>
25 Module implementing a dialog to enter the data for a transplant session.
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="#RevisionsValidator">RevisionsValidator</a></td>
35 <td>Class implementing a validator for the revisions line edit.</td>
36 </tr><tr>
37 <td><a href="#TransplantDialog">TransplantDialog</a></td>
38 <td>Class implementing a dialog to enter the data for a transplant session.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="RevisionsValidator" ID="RevisionsValidator"></a>
47 <h2>RevisionsValidator</h2>
48 <p>
49 Class implementing a validator for the revisions line edit.
50 </p>
51 <h3>Derived from</h3>
52 QValidator
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#RevisionsValidator.__init__">RevisionsValidator</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#RevisionsValidator.validate">validate</a></td>
64 <td>Public method to validate the given input.</td>
65 </tr>
66 </table>
67 <a NAME="RevisionsValidator.__init__" ID="RevisionsValidator.__init__"></a>
68 <h4>RevisionsValidator (Constructor)</h4>
69 <b>RevisionsValidator</b>(<i>multiRevsAllowed, parent=None</i>)
70 <p>
71 Constructor
72 </p><dl>
73 <dt><i>multiRevsAllowed</i></dt>
74 <dd>
75 flag indicating, if multi revs are allowed (boolean)
76 </dd><dt><i>parent</i></dt>
77 <dd>
78 reference to the parent object (QObject)
79 </dd>
80 </dl><a NAME="RevisionsValidator.validate" ID="RevisionsValidator.validate"></a>
81 <h4>RevisionsValidator.validate</h4>
82 <b>validate</b>(<i>input, pos</i>)
83 <p>
84 Public method to validate the given input.
85 </p><dl>
86 <dt><i>input</i></dt>
87 <dd>
88 input to be validated (string)
89 </dd><dt><i>pos</i></dt>
90 <dd>
91 position of the cursor (integer)
92 </dd>
93 </dl><dl>
94 <dt>Returns:</dt>
95 <dd>
96 tuple with validation result, input and position
97 (QValidator.State, string, integer)
98 </dd>
99 </dl>
100 <div align="right"><a href="#top">Up</a></div>
101 <hr /><hr />
102 <a NAME="TransplantDialog" ID="TransplantDialog"></a>
103 <h2>TransplantDialog</h2>
104 <p>
105 Class implementing a dialog to enter the data for a transplant session.
106 </p>
107 <h3>Derived from</h3>
108 QDialog, Ui_TransplantDialog
109 <h3>Class Attributes</h3>
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113 <h3>Methods</h3>
114 <table>
115 <tr>
116 <td><a href="#TransplantDialog.__init__">TransplantDialog</a></td>
117 <td>Constructor</td>
118 </tr><tr>
119 <td><a href="#TransplantDialog.__updateOk">__updateOk</a></td>
120 <td>Private slot to update the state of the OK button.</td>
121 </tr><tr>
122 <td><a href="#TransplantDialog.getData">getData</a></td>
123 <td>Public method to retrieve the entered data.</td>
124 </tr><tr>
125 <td><a href="#TransplantDialog.on_allCheckBox_clicked">on_allCheckBox_clicked</a></td>
126 <td>Private slot to react upon selection of the all check box.</td>
127 </tr><tr>
128 <td><a href="#TransplantDialog.on_branchesCombo_editTextChanged">on_branchesCombo_editTextChanged</a></td>
129 <td>Private slot to react upon changes of the branch name.</td>
130 </tr><tr>
131 <td><a href="#TransplantDialog.on_revisionsEdit_textChanged">on_revisionsEdit_textChanged</a></td>
132 <td>Private slot to react upon changes of revisions.</td>
133 </tr>
134 </table>
135 <a NAME="TransplantDialog.__init__" ID="TransplantDialog.__init__"></a>
136 <h4>TransplantDialog (Constructor)</h4>
137 <b>TransplantDialog</b>(<i>branchesList, parent=None</i>)
138 <p>
139 Constructor
140 </p><dl>
141 <dt><i>branchesList</i></dt>
142 <dd>
143 list of available branch names (list of strings)
144 </dd><dt><i>parent</i></dt>
145 <dd>
146 reference to the parent widget (QWidget)
147 </dd>
148 </dl><a NAME="TransplantDialog.__updateOk" ID="TransplantDialog.__updateOk"></a>
149 <h4>TransplantDialog.__updateOk</h4>
150 <b>__updateOk</b>(<i></i>)
151 <p>
152 Private slot to update the state of the OK button.
153 </p><a NAME="TransplantDialog.getData" ID="TransplantDialog.getData"></a>
154 <h4>TransplantDialog.getData</h4>
155 <b>getData</b>(<i></i>)
156 <p>
157 Public method to retrieve the entered data.
158 </p><dl>
159 <dt>Returns:</dt>
160 <dd>
161 tuple with list of revisions, source repo, branch name, a flag
162 indicating to transplant all, list of revisions to skip, list of
163 revisions to merge and a flag indicating to append transplant info
164 (list of strings, string, string, boolean, list of strings,
165 list of strings, boolean)
166 </dd>
167 </dl><a NAME="TransplantDialog.on_allCheckBox_clicked" ID="TransplantDialog.on_allCheckBox_clicked"></a>
168 <h4>TransplantDialog.on_allCheckBox_clicked</h4>
169 <b>on_allCheckBox_clicked</b>(<i>checked</i>)
170 <p>
171 Private slot to react upon selection of the all check box.
172 </p><dl>
173 <dt><i>checked</i></dt>
174 <dd>
175 state of the check box (boolean)
176 </dd>
177 </dl><a NAME="TransplantDialog.on_branchesCombo_editTextChanged" ID="TransplantDialog.on_branchesCombo_editTextChanged"></a>
178 <h4>TransplantDialog.on_branchesCombo_editTextChanged</h4>
179 <b>on_branchesCombo_editTextChanged</b>(<i>txt</i>)
180 <p>
181 Private slot to react upon changes of the branch name.
182 </p><dl>
183 <dt><i>txt</i></dt>
184 <dd>
185 contents of the branches combo (string)
186 </dd>
187 </dl><a NAME="TransplantDialog.on_revisionsEdit_textChanged" ID="TransplantDialog.on_revisionsEdit_textChanged"></a>
188 <h4>TransplantDialog.on_revisionsEdit_textChanged</h4>
189 <b>on_revisionsEdit_textChanged</b>(<i>txt</i>)
190 <p>
191 Private slot to react upon changes of revisions.
192 </p><dl>
193 <dt><i>txt</i></dt>
194 <dd>
195 contents of the revisions edit (string)
196 </dd>
197 </dl>
198 <div align="right"><a href="#top">Up</a></div>
199 <hr />
200 </body></html>

eric ide

mercurial