eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog.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.HgQueuesDefineGuardsDialog</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.HgQueuesDefineGuardsDialog</h1>
24
25 <p>
26 Module implementing a dialog to define guards for patches.
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="#HgQueuesDefineGuardsDialog">HgQueuesDefineGuardsDialog</a></td>
39 <td>Class implementing a dialog to define guards for patches.</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="HgQueuesDefineGuardsDialog" ID="HgQueuesDefineGuardsDialog"></a>
50 <h2>HgQueuesDefineGuardsDialog</h2>
51
52 <p>
53 Class implementing a dialog to define guards for patches.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_HgQueuesDefineGuardsDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</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="#HgQueuesDefineGuardsDialog.__init__">HgQueuesDefineGuardsDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgQueuesDefineGuardsDialog.__applyGuards">__applyGuards</a></td>
77 <td>Private slot to apply the defined guards to the current patch.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgQueuesDefineGuardsDialog.__getGuard">__getGuard</a></td>
81 <td>Private method to get a reference to a named guard.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgQueuesDefineGuardsDialog.closeEvent">closeEvent</a></td>
85 <td>Protected slot implementing a close event handler.</td>
86 </tr>
87 <tr>
88 <td><a href="#HgQueuesDefineGuardsDialog.on_addButton_clicked">on_addButton_clicked</a></td>
89 <td>Private slot to add a guard definition to the list or change it.</td>
90 </tr>
91 <tr>
92 <td><a href="#HgQueuesDefineGuardsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
93 <td>Private slot called by a button of the button box clicked.</td>
94 </tr>
95 <tr>
96 <td><a href="#HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged">on_guardCombo_editTextChanged</a></td>
97 <td>Private slot to handle changes of the text of the guard combo.</td>
98 </tr>
99 <tr>
100 <td><a href="#HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged">on_guardsList_itemSelectionChanged</a></td>
101 <td>Private slot to handle changes of the selection of guards.</td>
102 </tr>
103 <tr>
104 <td><a href="#HgQueuesDefineGuardsDialog.on_patchSelector_activated">on_patchSelector_activated</a></td>
105 <td>Private slot to get the list of guards defined for the given patch name.</td>
106 </tr>
107 <tr>
108 <td><a href="#HgQueuesDefineGuardsDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
109 <td>Private slot to remove guard definitions from the list.</td>
110 </tr>
111 <tr>
112 <td><a href="#HgQueuesDefineGuardsDialog.start">start</a></td>
113 <td>Public slot to start the list command.</td>
114 </tr>
115 </table>
116 <h3>Static Methods</h3>
117
118 <table>
119 <tr><td>None</td></tr>
120 </table>
121
122 <a NAME="HgQueuesDefineGuardsDialog.__init__" ID="HgQueuesDefineGuardsDialog.__init__"></a>
123 <h4>HgQueuesDefineGuardsDialog (Constructor)</h4>
124 <b>HgQueuesDefineGuardsDialog</b>(<i>vcs, extension, patchesList, parent=None</i>)
125
126 <p>
127 Constructor
128 </p>
129 <dl>
130
131 <dt><i>vcs</i></dt>
132 <dd>
133 reference to the vcs object
134 </dd>
135 <dt><i>extension</i></dt>
136 <dd>
137 reference to the extension module (Queues)
138 </dd>
139 <dt><i>patchesList</i></dt>
140 <dd>
141 list of patches (list of strings)
142 </dd>
143 <dt><i>parent</i></dt>
144 <dd>
145 reference to the parent widget (QWidget)
146 </dd>
147 </dl>
148 <a NAME="HgQueuesDefineGuardsDialog.__applyGuards" ID="HgQueuesDefineGuardsDialog.__applyGuards"></a>
149 <h4>HgQueuesDefineGuardsDialog.__applyGuards</h4>
150 <b>__applyGuards</b>(<i></i>)
151
152 <p>
153 Private slot to apply the defined guards to the current patch.
154 </p>
155 <a NAME="HgQueuesDefineGuardsDialog.__getGuard" ID="HgQueuesDefineGuardsDialog.__getGuard"></a>
156 <h4>HgQueuesDefineGuardsDialog.__getGuard</h4>
157 <b>__getGuard</b>(<i>guard</i>)
158
159 <p>
160 Private method to get a reference to a named guard.
161 </p>
162 <dl>
163
164 <dt><i>guard</i></dt>
165 <dd>
166 name of the guard (string)
167 </dd>
168 </dl>
169 <dl>
170 <dt>Return:</dt>
171 <dd>
172 reference to the guard item (QListWidgetItem)
173 </dd>
174 </dl>
175 <a NAME="HgQueuesDefineGuardsDialog.closeEvent" ID="HgQueuesDefineGuardsDialog.closeEvent"></a>
176 <h4>HgQueuesDefineGuardsDialog.closeEvent</h4>
177 <b>closeEvent</b>(<i>e</i>)
178
179 <p>
180 Protected slot implementing a close event handler.
181 </p>
182 <dl>
183
184 <dt><i>e</i></dt>
185 <dd>
186 close event (QCloseEvent)
187 </dd>
188 </dl>
189 <a NAME="HgQueuesDefineGuardsDialog.on_addButton_clicked" ID="HgQueuesDefineGuardsDialog.on_addButton_clicked"></a>
190 <h4>HgQueuesDefineGuardsDialog.on_addButton_clicked</h4>
191 <b>on_addButton_clicked</b>(<i></i>)
192
193 <p>
194 Private slot to add a guard definition to the list or change it.
195 </p>
196 <a NAME="HgQueuesDefineGuardsDialog.on_buttonBox_clicked" ID="HgQueuesDefineGuardsDialog.on_buttonBox_clicked"></a>
197 <h4>HgQueuesDefineGuardsDialog.on_buttonBox_clicked</h4>
198 <b>on_buttonBox_clicked</b>(<i>button</i>)
199
200 <p>
201 Private slot called by a button of the button box clicked.
202 </p>
203 <dl>
204
205 <dt><i>button</i></dt>
206 <dd>
207 button that was clicked (QAbstractButton)
208 </dd>
209 </dl>
210 <a NAME="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged" ID="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged"></a>
211 <h4>HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged</h4>
212 <b>on_guardCombo_editTextChanged</b>(<i>txt</i>)
213
214 <p>
215 Private slot to handle changes of the text of the guard combo.
216 </p>
217 <dl>
218
219 <dt><i>txt</i></dt>
220 <dd>
221 contents of the guard combo line edit (string)
222 </dd>
223 </dl>
224 <a NAME="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged" ID="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged"></a>
225 <h4>HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged</h4>
226 <b>on_guardsList_itemSelectionChanged</b>(<i></i>)
227
228 <p>
229 Private slot to handle changes of the selection of guards.
230 </p>
231 <a NAME="HgQueuesDefineGuardsDialog.on_patchSelector_activated" ID="HgQueuesDefineGuardsDialog.on_patchSelector_activated"></a>
232 <h4>HgQueuesDefineGuardsDialog.on_patchSelector_activated</h4>
233 <b>on_patchSelector_activated</b>(<i>index</i>)
234
235 <p>
236 Private slot to get the list of guards defined for the given patch
237 name.
238 </p>
239 <dl>
240
241 <dt><i>index</i> (int)</dt>
242 <dd>
243 index of the selected entry
244 </dd>
245 </dl>
246 <a NAME="HgQueuesDefineGuardsDialog.on_removeButton_clicked" ID="HgQueuesDefineGuardsDialog.on_removeButton_clicked"></a>
247 <h4>HgQueuesDefineGuardsDialog.on_removeButton_clicked</h4>
248 <b>on_removeButton_clicked</b>(<i></i>)
249
250 <p>
251 Private slot to remove guard definitions from the list.
252 </p>
253 <a NAME="HgQueuesDefineGuardsDialog.start" ID="HgQueuesDefineGuardsDialog.start"></a>
254 <h4>HgQueuesDefineGuardsDialog.start</h4>
255 <b>start</b>(<i></i>)
256
257 <p>
258 Public slot to start the list command.
259 </p>
260 <div align="right"><a href="#top">Up</a></div>
261 <hr />
262 </body></html>

eric ide

mercurial