src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog</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.QueuesExtension.HgQueuesQueueManagementDialog</h1>
10
11 <p>
12 Module implementing a dialog used by the queue management functions.
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="#HgQueuesQueueManagementDialog">HgQueuesQueueManagementDialog</a></td>
25 <td>Class implementing a dialog used by the queue management functions.</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="HgQueuesQueueManagementDialog" ID="HgQueuesQueueManagementDialog"></a>
36 <h2>HgQueuesQueueManagementDialog</h2>
37
38 <p>
39 Class implementing a dialog used by the queue management functions.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgQueuesQueueManagementDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>NAME_INPUT</td></tr><tr><td>NO_INPUT</td></tr><tr><td>QUEUE_INPUT</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="#HgQueuesQueueManagementDialog.__init__">HgQueuesQueueManagementDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgQueuesQueueManagementDialog.__getQueuesList">__getQueuesList</a></td>
63 <td>Private method to get a list of all queues and the name of the active queue.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgQueuesQueueManagementDialog.getData">getData</a></td>
67 <td>Public slot to get the data.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgQueuesQueueManagementDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
71 <td>Private slot called by a button of the button box clicked.</td>
72 </tr>
73 <tr>
74 <td><a href="#HgQueuesQueueManagementDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
75 <td>Private slot to handle changes of the entered queue name.</td>
76 </tr>
77 <tr>
78 <td><a href="#HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged">on_queuesList_itemSelectionChanged</a></td>
79 <td>Private slot to handle changes of selected queue names.</td>
80 </tr>
81 <tr>
82 <td><a href="#HgQueuesQueueManagementDialog.refresh">refresh</a></td>
83 <td>Public slot to refresh the list of queues.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="HgQueuesQueueManagementDialog.__init__" ID="HgQueuesQueueManagementDialog.__init__"></a>
93 <h4>HgQueuesQueueManagementDialog (Constructor)</h4>
94 <b>HgQueuesQueueManagementDialog</b>(<i>mode, title, suppressActive, vcs, parent=None</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>mode</i></dt>
102 <dd>
103 mode of the dialog (HgQueuesQueueManagementDialog.NO_INPUT
104 HgQueuesQueueManagementDialog.NAME_INPUT,
105 HgQueuesQueueManagementDialog.QUEUE_INPUT)
106 </dd>
107 <dt><i>title</i></dt>
108 <dd>
109 title for the dialog (string)
110 </dd>
111 <dt><i>suppressActive</i></dt>
112 <dd>
113 flag indicating to not show the name of the
114 active queue (boolean)
115 </dd>
116 <dt><i>vcs</i></dt>
117 <dd>
118 reference to the vcs object
119 </dd>
120 <dt><i>parent</i></dt>
121 <dd>
122 reference to the parent widget (QWidget)
123 </dd>
124 </dl>
125 <dl>
126
127 <dt>Raises <b>ValueError</b>:</dt>
128 <dd>
129 raised to indicate an invalid dialog mode
130 </dd>
131 </dl>
132 <a NAME="HgQueuesQueueManagementDialog.__getQueuesList" ID="HgQueuesQueueManagementDialog.__getQueuesList"></a>
133 <h4>HgQueuesQueueManagementDialog.__getQueuesList</h4>
134 <b>__getQueuesList</b>(<i></i>)
135
136 <p>
137 Private method to get a list of all queues and the name of the active
138 queue.
139 </p>
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 tuple with a list of all queues and the name of the active
144 queue (list of strings, string)
145 </dd>
146 </dl>
147 <a NAME="HgQueuesQueueManagementDialog.getData" ID="HgQueuesQueueManagementDialog.getData"></a>
148 <h4>HgQueuesQueueManagementDialog.getData</h4>
149 <b>getData</b>(<i></i>)
150
151 <p>
152 Public slot to get the data.
153 </p>
154 <dl>
155 <dt>Return:</dt>
156 <dd>
157 queue name (string)
158 </dd>
159 </dl>
160 <a NAME="HgQueuesQueueManagementDialog.on_buttonBox_clicked" ID="HgQueuesQueueManagementDialog.on_buttonBox_clicked"></a>
161 <h4>HgQueuesQueueManagementDialog.on_buttonBox_clicked</h4>
162 <b>on_buttonBox_clicked</b>(<i>button</i>)
163
164 <p>
165 Private slot called by a button of the button box clicked.
166 </p>
167 <dl>
168
169 <dt><i>button</i></dt>
170 <dd>
171 button that was clicked (QAbstractButton)
172 </dd>
173 </dl>
174 <a NAME="HgQueuesQueueManagementDialog.on_nameEdit_textChanged" ID="HgQueuesQueueManagementDialog.on_nameEdit_textChanged"></a>
175 <h4>HgQueuesQueueManagementDialog.on_nameEdit_textChanged</h4>
176 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
177
178 <p>
179 Private slot to handle changes of the entered queue name.
180 </p>
181 <dl>
182
183 <dt><i>txt</i></dt>
184 <dd>
185 text of the edit (string)
186 </dd>
187 </dl>
188 <a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a>
189 <h4>HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged</h4>
190 <b>on_queuesList_itemSelectionChanged</b>(<i></i>)
191
192 <p>
193 Private slot to handle changes of selected queue names.
194 </p>
195 <a NAME="HgQueuesQueueManagementDialog.refresh" ID="HgQueuesQueueManagementDialog.refresh"></a>
196 <h4>HgQueuesQueueManagementDialog.refresh</h4>
197 <b>refresh</b>(<i></i>)
198
199 <p>
200 Public slot to refresh the list of queues.
201 </p>
202 <div align="right"><a href="#top">Up</a></div>
203 <hr />
204 </body></html>

eric ide

mercurial