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

branch
eric7
changeset 10493
f795d68d8e09
parent 10479
856476537696
equal deleted inserted replaced
10492:53eac4c7d10b 10493:f795d68d8e09
20 <table> 20 <table>
21 <tr> 21 <tr>
22 <td><a href="#HgQueuesQueueManagementDialog">HgQueuesQueueManagementDialog</a></td> 22 <td><a href="#HgQueuesQueueManagementDialog">HgQueuesQueueManagementDialog</a></td>
23 <td>Class implementing a dialog used by the queue management functions.</td> 23 <td>Class implementing a dialog used by the queue management functions.</td>
24 </tr> 24 </tr>
25 <tr>
26 <td><a href="#HgQueuesQueueManagementDialogMode">HgQueuesQueueManagementDialogMode</a></td>
27 <td>Class defining the supported dialog modes.</td>
28 </tr>
25 </table> 29 </table>
26 30
27 <h3>Functions</h3> 31 <h3>Functions</h3>
28 <table> 32 <table>
29 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
39 43
40 <h3>Derived from</h3> 44 <h3>Derived from</h3>
41 QDialog, Ui_HgQueuesQueueManagementDialog 45 QDialog, Ui_HgQueuesQueueManagementDialog
42 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
43 <table> 47 <table>
48 <tr><td>None</td></tr>
49 </table>
50
51 <h3>Class Methods</h3>
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55
56 <h3>Methods</h3>
57 <table>
58 <tr>
59 <td><a href="#HgQueuesQueueManagementDialog.__init__">HgQueuesQueueManagementDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#HgQueuesQueueManagementDialog.__getQueuesList">__getQueuesList</a></td>
64 <td>Private method to get a list of all queues and the name of the active queue.</td>
65 </tr>
66 <tr>
67 <td><a href="#HgQueuesQueueManagementDialog.getData">getData</a></td>
68 <td>Public slot to get the data.</td>
69 </tr>
70 <tr>
71 <td><a href="#HgQueuesQueueManagementDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
72 <td>Private slot called by a button of the button box clicked.</td>
73 </tr>
74 <tr>
75 <td><a href="#HgQueuesQueueManagementDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
76 <td>Private slot to handle changes of the entered queue name.</td>
77 </tr>
78 <tr>
79 <td><a href="#HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged">on_queuesList_itemSelectionChanged</a></td>
80 <td>Private slot to handle changes of selected queue names.</td>
81 </tr>
82 <tr>
83 <td><a href="#HgQueuesQueueManagementDialog.refresh">refresh</a></td>
84 <td>Public slot to refresh the list of queues.</td>
85 </tr>
86 </table>
87
88 <h3>Static Methods</h3>
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92
93
94 <a NAME="HgQueuesQueueManagementDialog.__init__" ID="HgQueuesQueueManagementDialog.__init__"></a>
95 <h4>HgQueuesQueueManagementDialog (Constructor)</h4>
96 <b>HgQueuesQueueManagementDialog</b>(<i>mode, title, suppressActive, vcs, parent=None</i>)
97 <p>
98 Constructor
99 </p>
100
101 <dl>
102
103 <dt><i>mode</i> (HgQueuesQueueManagementDialogMode)</dt>
104 <dd>
105 mode of the dialog
106 </dd>
107 <dt><i>title</i> (str)</dt>
108 <dd>
109 title for the dialog
110 </dd>
111 <dt><i>suppressActive</i> (bool)</dt>
112 <dd>
113 flag indicating to not show the name of the
114 active queue
115 </dd>
116 <dt><i>vcs</i> (Hg)</dt>
117 <dd>
118 reference to the vcs object
119 </dd>
120 <dt><i>parent</i> (QWidget)</dt>
121 <dd>
122 reference to the parent widget
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 <p>
136 Private method to get a list of all queues and the name of the active
137 queue.
138 </p>
139
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 tuple with a list of all queues and the name of the active queue
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 tuple of (list of str, str)
150 </dd>
151 </dl>
152 <a NAME="HgQueuesQueueManagementDialog.getData" ID="HgQueuesQueueManagementDialog.getData"></a>
153 <h4>HgQueuesQueueManagementDialog.getData</h4>
154 <b>getData</b>(<i></i>)
155 <p>
156 Public slot to get the data.
157 </p>
158
159 <dl>
160 <dt>Return:</dt>
161 <dd>
162 queue name
163 </dd>
164 </dl>
165 <dl>
166 <dt>Return Type:</dt>
167 <dd>
168 str
169 </dd>
170 </dl>
171 <a NAME="HgQueuesQueueManagementDialog.on_buttonBox_clicked" ID="HgQueuesQueueManagementDialog.on_buttonBox_clicked"></a>
172 <h4>HgQueuesQueueManagementDialog.on_buttonBox_clicked</h4>
173 <b>on_buttonBox_clicked</b>(<i>button</i>)
174 <p>
175 Private slot called by a button of the button box clicked.
176 </p>
177
178 <dl>
179
180 <dt><i>button</i> (QAbstractButton)</dt>
181 <dd>
182 button that was clicked
183 </dd>
184 </dl>
185 <a NAME="HgQueuesQueueManagementDialog.on_nameEdit_textChanged" ID="HgQueuesQueueManagementDialog.on_nameEdit_textChanged"></a>
186 <h4>HgQueuesQueueManagementDialog.on_nameEdit_textChanged</h4>
187 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
188 <p>
189 Private slot to handle changes of the entered queue name.
190 </p>
191
192 <dl>
193
194 <dt><i>txt</i> (str)</dt>
195 <dd>
196 text of the edit
197 </dd>
198 </dl>
199 <a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a>
200 <h4>HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged</h4>
201 <b>on_queuesList_itemSelectionChanged</b>(<i></i>)
202 <p>
203 Private slot to handle changes of selected queue names.
204 </p>
205
206 <a NAME="HgQueuesQueueManagementDialog.refresh" ID="HgQueuesQueueManagementDialog.refresh"></a>
207 <h4>HgQueuesQueueManagementDialog.refresh</h4>
208 <b>refresh</b>(<i></i>)
209 <p>
210 Public slot to refresh the list of queues.
211 </p>
212
213 <div align="right"><a href="#top">Up</a></div>
214 <hr />
215 <hr />
216 <a NAME="HgQueuesQueueManagementDialogMode" ID="HgQueuesQueueManagementDialogMode"></a>
217 <h2>HgQueuesQueueManagementDialogMode</h2>
218 <p>
219 Class defining the supported dialog modes.
220 </p>
221
222 <h3>Derived from</h3>
223 enum.Enum
224 <h3>Class Attributes</h3>
225 <table>
44 <tr><td>NAME_INPUT</td></tr> 226 <tr><td>NAME_INPUT</td></tr>
45 <tr><td>NO_INPUT</td></tr> 227 <tr><td>NO_INPUT</td></tr>
46 <tr><td>QUEUE_INPUT</td></tr> 228 <tr><td>QUEUE_INPUT</td></tr>
47 </table> 229 </table>
48 230
51 <tr><td>None</td></tr> 233 <tr><td>None</td></tr>
52 </table> 234 </table>
53 235
54 <h3>Methods</h3> 236 <h3>Methods</h3>
55 <table> 237 <table>
56 <tr> 238 <tr><td>None</td></tr>
57 <td><a href="#HgQueuesQueueManagementDialog.__init__">HgQueuesQueueManagementDialog</a></td>
58 <td>Constructor</td>
59 </tr>
60 <tr>
61 <td><a href="#HgQueuesQueueManagementDialog.__getQueuesList">__getQueuesList</a></td>
62 <td>Private method to get a list of all queues and the name of the active queue.</td>
63 </tr>
64 <tr>
65 <td><a href="#HgQueuesQueueManagementDialog.getData">getData</a></td>
66 <td>Public slot to get the data.</td>
67 </tr>
68 <tr>
69 <td><a href="#HgQueuesQueueManagementDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
70 <td>Private slot called by a button of the button box clicked.</td>
71 </tr>
72 <tr>
73 <td><a href="#HgQueuesQueueManagementDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
74 <td>Private slot to handle changes of the entered queue name.</td>
75 </tr>
76 <tr>
77 <td><a href="#HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged">on_queuesList_itemSelectionChanged</a></td>
78 <td>Private slot to handle changes of selected queue names.</td>
79 </tr>
80 <tr>
81 <td><a href="#HgQueuesQueueManagementDialog.refresh">refresh</a></td>
82 <td>Public slot to refresh the list of queues.</td>
83 </tr>
84 </table> 239 </table>
85 240
86 <h3>Static Methods</h3> 241 <h3>Static Methods</h3>
87 <table> 242 <table>
88 <tr><td>None</td></tr> 243 <tr><td>None</td></tr>
89 </table> 244 </table>
90 245
91 246
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 <p>
96 Constructor
97 </p>
98
99 <dl>
100
101 <dt><i>mode</i> (int)</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> (str)</dt>
108 <dd>
109 title for the dialog
110 </dd>
111 <dt><i>suppressActive</i> (bool)</dt>
112 <dd>
113 flag indicating to not show the name of the
114 active queue
115 </dd>
116 <dt><i>vcs</i> (Hg)</dt>
117 <dd>
118 reference to the vcs object
119 </dd>
120 <dt><i>parent</i> (QWidget)</dt>
121 <dd>
122 reference to the parent widget
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 <p>
136 Private method to get a list of all queues and the name of the active
137 queue.
138 </p>
139
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 tuple with a list of all queues and the name of the active queue
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 tuple of (list of str, str)
150 </dd>
151 </dl>
152 <a NAME="HgQueuesQueueManagementDialog.getData" ID="HgQueuesQueueManagementDialog.getData"></a>
153 <h4>HgQueuesQueueManagementDialog.getData</h4>
154 <b>getData</b>(<i></i>)
155 <p>
156 Public slot to get the data.
157 </p>
158
159 <dl>
160 <dt>Return:</dt>
161 <dd>
162 queue name
163 </dd>
164 </dl>
165 <dl>
166 <dt>Return Type:</dt>
167 <dd>
168 str
169 </dd>
170 </dl>
171 <a NAME="HgQueuesQueueManagementDialog.on_buttonBox_clicked" ID="HgQueuesQueueManagementDialog.on_buttonBox_clicked"></a>
172 <h4>HgQueuesQueueManagementDialog.on_buttonBox_clicked</h4>
173 <b>on_buttonBox_clicked</b>(<i>button</i>)
174 <p>
175 Private slot called by a button of the button box clicked.
176 </p>
177
178 <dl>
179
180 <dt><i>button</i> (QAbstractButton)</dt>
181 <dd>
182 button that was clicked
183 </dd>
184 </dl>
185 <a NAME="HgQueuesQueueManagementDialog.on_nameEdit_textChanged" ID="HgQueuesQueueManagementDialog.on_nameEdit_textChanged"></a>
186 <h4>HgQueuesQueueManagementDialog.on_nameEdit_textChanged</h4>
187 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
188 <p>
189 Private slot to handle changes of the entered queue name.
190 </p>
191
192 <dl>
193
194 <dt><i>txt</i> (str)</dt>
195 <dd>
196 text of the edit
197 </dd>
198 </dl>
199 <a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a>
200 <h4>HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged</h4>
201 <b>on_queuesList_itemSelectionChanged</b>(<i></i>)
202 <p>
203 Private slot to handle changes of selected queue names.
204 </p>
205
206 <a NAME="HgQueuesQueueManagementDialog.refresh" ID="HgQueuesQueueManagementDialog.refresh"></a>
207 <h4>HgQueuesQueueManagementDialog.refresh</h4>
208 <b>refresh</b>(<i></i>)
209 <p>
210 Public slot to refresh the list of queues.
211 </p>
212
213 <div align="right"><a href="#top">Up</a></div> 247 <div align="right"><a href="#top">Up</a></div>
214 <hr /> 248 <hr />
215 </body></html> 249 </body></html>

eric ide

mercurial