src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.HgRebaseDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9029
14efd8fa5d8f
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.HgRebaseDialog</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.RebaseExtension.HgRebaseDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the data for a rebase 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="#HgRebaseDialog">HgRebaseDialog</a></td>
25 <td>Class implementing a dialog to enter the data for a rebase 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="HgRebaseDialog" ID="HgRebaseDialog"></a>
36 <h2>HgRebaseDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the data for a rebase session.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgRebaseDialog
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="#HgRebaseDialog.__init__">HgRebaseDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgRebaseDialog.__getRevision">__getRevision</a></td>
63 <td>Private method to generate the revision.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgRebaseDialog.__updateOK">__updateOK</a></td>
67 <td>Private slot to update the OK button.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgRebaseDialog.getData">getData</a></td>
71 <td>Public method to retrieve the data for the rebase session.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="HgRebaseDialog.__init__" ID="HgRebaseDialog.__init__"></a>
81 <h4>HgRebaseDialog (Constructor)</h4>
82 <b>HgRebaseDialog</b>(<i>tagsList, branchesList, bookmarksList, version, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>tagsList</i> (list of str)</dt>
90 <dd>
91 list of tags
92 </dd>
93 <dt><i>branchesList</i> (list of str)</dt>
94 <dd>
95 list of branches
96 </dd>
97 <dt><i>bookmarksList</i> (list of str)</dt>
98 <dd>
99 list of bookmarks
100 </dd>
101 <dt><i>version</i> (tuple of int)</dt>
102 <dd>
103 tuple giving the Mercurial version
104 </dd>
105 <dt><i>parent</i> (QWidget)</dt>
106 <dd>
107 reference to the parent widget
108 </dd>
109 </dl>
110 <a NAME="HgRebaseDialog.__getRevision" ID="HgRebaseDialog.__getRevision"></a>
111 <h4>HgRebaseDialog.__getRevision</h4>
112 <b>__getRevision</b>(<i>no</i>)
113
114 <p>
115 Private method to generate the revision.
116 </p>
117 <dl>
118
119 <dt><i>no</i> (int)</dt>
120 <dd>
121 revision number to generate (1 or 2)
122 </dd>
123 </dl>
124 <dl>
125 <dt>Return:</dt>
126 <dd>
127 revision
128 </dd>
129 </dl>
130 <dl>
131 <dt>Return Type:</dt>
132 <dd>
133 str
134 </dd>
135 </dl>
136 <a NAME="HgRebaseDialog.__updateOK" ID="HgRebaseDialog.__updateOK"></a>
137 <h4>HgRebaseDialog.__updateOK</h4>
138 <b>__updateOK</b>(<i></i>)
139
140 <p>
141 Private slot to update the OK button.
142 </p>
143 <a NAME="HgRebaseDialog.getData" ID="HgRebaseDialog.getData"></a>
144 <h4>HgRebaseDialog.getData</h4>
145 <b>getData</b>(<i></i>)
146
147 <p>
148 Public method to retrieve the data for the rebase session.
149 </p>
150 <dl>
151 <dt>Return:</dt>
152 <dd>
153 tuple with a source indicator of "S" or "B", the source
154 revision, the destination revision, a flag indicating to collapse,
155 a flag indicating to keep the original changesets, a flag
156 indicating to keep the original branch name, a flag indicating
157 to detach the source, a flag indicating to perform a dry-run only
158 and a flag indicating to perform a dry-run first, than ask for
159 confirmation
160 </dd>
161 </dl>
162 <dl>
163 <dt>Return Type:</dt>
164 <dd>
165 tuple of (str, str, str, bool, bool, bool, bool, bool, bool)
166 </dd>
167 </dl>
168 <div align="right"><a href="#top">Up</a></div>
169 <hr />
170 </body></html>

eric ide

mercurial