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

changeset 7010
5d6f5a69a952
child 7273
391d6b7b1eff
equal deleted inserted replaced
7009:eaf5ed6ef298 7010:5d6f5a69a952
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</h1>
23 <p>
24 Module implementing a dialog to select the heads to be closed.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#HgCloseHeadSelectionDialog">HgCloseHeadSelectionDialog</a></td>
34 <td>Class implementing a dialog to select the heads to be closed.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HgCloseHeadSelectionDialog" ID="HgCloseHeadSelectionDialog"></a>
43 <h2>HgCloseHeadSelectionDialog</h2>
44 <p>
45 Class implementing a dialog to select the heads to be closed.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_HgCloseHeadSelectionDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#HgCloseHeadSelectionDialog.__init__">HgCloseHeadSelectionDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#HgCloseHeadSelectionDialog.__getHeads">__getHeads</a></td>
64 <td>Private method to get the open heads.</td>
65 </tr><tr>
66 <td><a href="#HgCloseHeadSelectionDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td>
68 </tr><tr>
69 <td><a href="#HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged">on_headsList_itemSelectionChanged</a></td>
70 <td>Private slot handling changes of the selection.</td>
71 </tr>
72 </table>
73 <h3>Static Methods</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <a NAME="HgCloseHeadSelectionDialog.__init__" ID="HgCloseHeadSelectionDialog.__init__"></a>
78 <h4>HgCloseHeadSelectionDialog (Constructor)</h4>
79 <b>HgCloseHeadSelectionDialog</b>(<i>vcs, ppath, parent=None</i>)
80 <p>
81 Constructor
82 </p><dl>
83 <dt><i>vcs</i> (Hg)</dt>
84 <dd>
85 reference to the VCS object
86 </dd><dt><i>ppath</i> (str)</dt>
87 <dd>
88 directory containing the repository
89 </dd><dt><i>parent</i> (QWidget)</dt>
90 <dd>
91 reference to the parent widget
92 </dd>
93 </dl><a NAME="HgCloseHeadSelectionDialog.__getHeads" ID="HgCloseHeadSelectionDialog.__getHeads"></a>
94 <h4>HgCloseHeadSelectionDialog.__getHeads</h4>
95 <b>__getHeads</b>(<i>vcs, ppath</i>)
96 <p>
97 Private method to get the open heads.
98 </p><dl>
99 <dt><i>vcs</i> (Hg)</dt>
100 <dd>
101 reference to the VCS object
102 </dd><dt><i>ppath</i> (str)</dt>
103 <dd>
104 directory containing the repository
105 </dd>
106 </dl><dl>
107 <dt>Returns:</dt>
108 <dd>
109 list of tuples containing the revision and the corresponding
110 branch name
111 </dd>
112 </dl><dl>
113 <dt>Return Type:</dt>
114 <dd>
115 list of tuples of (str, str)
116 </dd>
117 </dl><a NAME="HgCloseHeadSelectionDialog.getData" ID="HgCloseHeadSelectionDialog.getData"></a>
118 <h4>HgCloseHeadSelectionDialog.getData</h4>
119 <b>getData</b>(<i></i>)
120 <p>
121 Public method to retrieve the entered data.
122 </p><dl>
123 <dt>Returns:</dt>
124 <dd>
125 tuple containing a list of selected revisions and the commit
126 message
127 </dd>
128 </dl><dl>
129 <dt>Return Type:</dt>
130 <dd>
131 tuple of (list of str, str)
132 </dd>
133 </dl><a NAME="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged" ID="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged"></a>
134 <h4>HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged</h4>
135 <b>on_headsList_itemSelectionChanged</b>(<i></i>)
136 <p>
137 Private slot handling changes of the selection.
138 </p>
139 <div align="right"><a href="#top">Up</a></div>
140 <hr />
141 </body></html>

eric ide

mercurial