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

eric ide

mercurial