eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</h1>
24
25 <p>
26 Module implementing a dialog to select the heads to be closed.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HgCloseHeadSelectionDialog">HgCloseHeadSelectionDialog</a></td>
39 <td>Class implementing a dialog to select the heads to be closed.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HgCloseHeadSelectionDialog" ID="HgCloseHeadSelectionDialog"></a>
50 <h2>HgCloseHeadSelectionDialog</h2>
51
52 <p>
53 Class implementing a dialog to select the heads to be closed.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_HgCloseHeadSelectionDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#HgCloseHeadSelectionDialog.__init__">HgCloseHeadSelectionDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgCloseHeadSelectionDialog.__getHeads">__getHeads</a></td>
77 <td>Private method to get the open heads.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgCloseHeadSelectionDialog.getData">getData</a></td>
81 <td>Public method to retrieve the entered data.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged">on_headsList_itemSelectionChanged</a></td>
85 <td>Private slot handling changes of the selection.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="HgCloseHeadSelectionDialog.__init__" ID="HgCloseHeadSelectionDialog.__init__"></a>
95 <h4>HgCloseHeadSelectionDialog (Constructor)</h4>
96 <b>HgCloseHeadSelectionDialog</b>(<i>vcs, parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>vcs</i> (Hg)</dt>
104 <dd>
105 reference to the VCS object
106 </dd>
107 <dt><i>parent</i> (QWidget)</dt>
108 <dd>
109 reference to the parent widget
110 </dd>
111 </dl>
112 <a NAME="HgCloseHeadSelectionDialog.__getHeads" ID="HgCloseHeadSelectionDialog.__getHeads"></a>
113 <h4>HgCloseHeadSelectionDialog.__getHeads</h4>
114 <b>__getHeads</b>(<i>vcs</i>)
115
116 <p>
117 Private method to get the open heads.
118 </p>
119 <dl>
120
121 <dt><i>vcs</i> (Hg)</dt>
122 <dd>
123 reference to the VCS object
124 </dd>
125 </dl>
126 <dl>
127 <dt>Return:</dt>
128 <dd>
129 list of tuples containing the revision and the corresponding
130 branch name
131 </dd>
132 </dl>
133 <dl>
134 <dt>Return Type:</dt>
135 <dd>
136 list of tuples of (str, str)
137 </dd>
138 </dl>
139 <a NAME="HgCloseHeadSelectionDialog.getData" ID="HgCloseHeadSelectionDialog.getData"></a>
140 <h4>HgCloseHeadSelectionDialog.getData</h4>
141 <b>getData</b>(<i></i>)
142
143 <p>
144 Public method to retrieve the entered data.
145 </p>
146 <dl>
147 <dt>Return:</dt>
148 <dd>
149 tuple containing a list of selected revisions and the commit
150 message
151 </dd>
152 </dl>
153 <dl>
154 <dt>Return Type:</dt>
155 <dd>
156 tuple of (list of str, str)
157 </dd>
158 </dl>
159 <a NAME="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged" ID="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged"></a>
160 <h4>HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged</h4>
161 <b>on_headsList_itemSelectionChanged</b>(<i></i>)
162
163 <p>
164 Private slot handling changes of the selection.
165 </p>
166 <div align="right"><a href="#top">Up</a></div>
167 <hr />
168 </body></html>

eric ide

mercurial