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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</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.CloseheadExtension.HgCloseHeadSelectionDialog</h1>
10
11 <p>
12 Module implementing a dialog to select the heads to be closed.
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="#HgCloseHeadSelectionDialog">HgCloseHeadSelectionDialog</a></td>
25 <td>Class implementing a dialog to select the heads to be closed.</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="HgCloseHeadSelectionDialog" ID="HgCloseHeadSelectionDialog"></a>
36 <h2>HgCloseHeadSelectionDialog</h2>
37
38 <p>
39 Class implementing a dialog to select the heads to be closed.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgCloseHeadSelectionDialog
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="#HgCloseHeadSelectionDialog.__init__">HgCloseHeadSelectionDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgCloseHeadSelectionDialog.__getHeads">__getHeads</a></td>
63 <td>Private method to get the open heads.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgCloseHeadSelectionDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged">on_headsList_itemSelectionChanged</a></td>
71 <td>Private slot handling changes of the selection.</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="HgCloseHeadSelectionDialog.__init__" ID="HgCloseHeadSelectionDialog.__init__"></a>
81 <h4>HgCloseHeadSelectionDialog (Constructor)</h4>
82 <b>HgCloseHeadSelectionDialog</b>(<i>vcs, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>vcs</i> (Hg)</dt>
90 <dd>
91 reference to the VCS object
92 </dd>
93 <dt><i>parent</i> (QWidget)</dt>
94 <dd>
95 reference to the parent widget
96 </dd>
97 </dl>
98 <a NAME="HgCloseHeadSelectionDialog.__getHeads" ID="HgCloseHeadSelectionDialog.__getHeads"></a>
99 <h4>HgCloseHeadSelectionDialog.__getHeads</h4>
100 <b>__getHeads</b>(<i>vcs</i>)
101
102 <p>
103 Private method to get the open heads.
104 </p>
105 <dl>
106
107 <dt><i>vcs</i> (Hg)</dt>
108 <dd>
109 reference to the VCS object
110 </dd>
111 </dl>
112 <dl>
113 <dt>Return:</dt>
114 <dd>
115 list of tuples containing the revision and the corresponding
116 branch name
117 </dd>
118 </dl>
119 <dl>
120 <dt>Return Type:</dt>
121 <dd>
122 list of tuples of (str, str)
123 </dd>
124 </dl>
125 <a NAME="HgCloseHeadSelectionDialog.getData" ID="HgCloseHeadSelectionDialog.getData"></a>
126 <h4>HgCloseHeadSelectionDialog.getData</h4>
127 <b>getData</b>(<i></i>)
128
129 <p>
130 Public method to retrieve the entered data.
131 </p>
132 <dl>
133 <dt>Return:</dt>
134 <dd>
135 tuple containing a list of selected revisions and the commit
136 message
137 </dd>
138 </dl>
139 <dl>
140 <dt>Return Type:</dt>
141 <dd>
142 tuple of (list of str, str)
143 </dd>
144 </dl>
145 <a NAME="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged" ID="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged"></a>
146 <h4>HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged</h4>
147 <b>on_headsList_itemSelectionChanged</b>(<i></i>)
148
149 <p>
150 Private slot handling changes of the selection.
151 </p>
152 <div align="right"><a href="#top">Up</a></div>
153 <hr />
154 </body></html>

eric ide

mercurial