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

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

eric ide

mercurial