src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.HgShelvesSelectionDialog.html

branch
eric7
changeset 11068
15f0385e0471
equal deleted inserted replaced
11067:67b92e2cb719 11068:15f0385e0471
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.HgShelvesSelectionDialog</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.ShelveBuiltin.HgShelvesSelectionDialog</h1>
10 <p>
11 Module implementing a dialog to select multiple shelve names.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#HgShelvesSelectionDialog">HgShelvesSelectionDialog</a></td>
23 <td>Class implementing a dialog to select multiple shelve names.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="HgShelvesSelectionDialog" ID="HgShelvesSelectionDialog"></a>
35 <h2>HgShelvesSelectionDialog</h2>
36 <p>
37 Class implementing a dialog to select multiple shelve names.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_HgShelvesSelectionDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#HgShelvesSelectionDialog.__init__">HgShelvesSelectionDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#HgShelvesSelectionDialog.getSelectedShelves">getSelectedShelves</a></td>
60 <td>Public method to retrieve the selected shelve names.</td>
61 </tr>
62 <tr>
63 <td><a href="#HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged">on_shelvesList_itemSelectionChanged</a></td>
64 <td>Private slot to enabled the OK button if items have been selected.</td>
65 </tr>
66 </table>
67
68 <h3>Static Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72
73
74 <a NAME="HgShelvesSelectionDialog.__init__" ID="HgShelvesSelectionDialog.__init__"></a>
75 <h4>HgShelvesSelectionDialog (Constructor)</h4>
76 <b>HgShelvesSelectionDialog</b>(<i>message, shelveNames, parent=None</i>)
77 <p>
78 Constructor
79 </p>
80
81 <dl>
82
83 <dt><i>message</i> (str)</dt>
84 <dd>
85 message to be shown
86 </dd>
87 <dt><i>shelveNames</i> (list of str)</dt>
88 <dd>
89 list of shelve names
90 </dd>
91 <dt><i>parent</i> (QWidget)</dt>
92 <dd>
93 reference to the parent widget
94 </dd>
95 </dl>
96 <a NAME="HgShelvesSelectionDialog.getSelectedShelves" ID="HgShelvesSelectionDialog.getSelectedShelves"></a>
97 <h4>HgShelvesSelectionDialog.getSelectedShelves</h4>
98 <b>getSelectedShelves</b>(<i></i>)
99 <p>
100 Public method to retrieve the selected shelve names.
101 </p>
102
103 <dl>
104 <dt>Return:</dt>
105 <dd>
106 selected shelve names
107 </dd>
108 </dl>
109 <dl>
110 <dt>Return Type:</dt>
111 <dd>
112 list of str
113 </dd>
114 </dl>
115 <a NAME="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged" ID="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged"></a>
116 <h4>HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged</h4>
117 <b>on_shelvesList_itemSelectionChanged</b>(<i></i>)
118 <p>
119 Private slot to enabled the OK button if items have been selected.
120 </p>
121
122 <div align="right"><a href="#top">Up</a></div>
123 <hr />
124 </body></html>

eric ide

mercurial