|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to define guards for patches. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#HgQueuesDefineGuardsDialog">HgQueuesDefineGuardsDialog</a></td> |
|
34 <td>Class implementing a dialog to define guards for patches.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="HgQueuesDefineGuardsDialog" ID="HgQueuesDefineGuardsDialog"></a> |
|
43 <h2>HgQueuesDefineGuardsDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog to define guards for patches. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_HgQueuesDefineGuardsDialog |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#HgQueuesDefineGuardsDialog.__init__">HgQueuesDefineGuardsDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#HgQueuesDefineGuardsDialog.__applyGuards">__applyGuards</a></td> |
|
64 <td>Private slot to apply the defined guards to the current patch.</td> |
|
65 </tr><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><tr> |
|
69 <td><a href="#HgQueuesDefineGuardsDialog.closeEvent">closeEvent</a></td> |
|
70 <td>Protected slot implementing a close event handler.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HgQueuesDefineGuardsDialog.on_addButton_clicked">on_addButton_clicked</a></td> |
|
73 <td>Private slot to add a guard definition to the list or change it.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#HgQueuesDefineGuardsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
76 <td>Private slot called by a button of the button box clicked.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged">on_guardCombo_editTextChanged</a></td> |
|
79 <td>Private slot to handle changes of the text of the guard combo.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged">on_guardsList_itemSelectionChanged</a></td> |
|
82 <td>Private slot to handle changes of the selection of guards.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#HgQueuesDefineGuardsDialog.on_patchSelector_activated">on_patchSelector_activated</a></td> |
|
85 <td>Private slot to get the list of guards defined for the given patch name.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#HgQueuesDefineGuardsDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> |
|
88 <td>Private slot to remove guard definitions from the list.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#HgQueuesDefineGuardsDialog.start">start</a></td> |
|
91 <td>Public slot to start the list command.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <h3>Static Methods</h3> |
|
95 <table> |
|
96 <tr><td>None</td></tr> |
|
97 </table> |
|
98 <a NAME="HgQueuesDefineGuardsDialog.__init__" ID="HgQueuesDefineGuardsDialog.__init__"></a> |
|
99 <h4>HgQueuesDefineGuardsDialog (Constructor)</h4> |
|
100 <b>HgQueuesDefineGuardsDialog</b>(<i>vcs, extension, patchesList, parent=None</i>) |
|
101 <p> |
|
102 Constructor |
|
103 </p><dl> |
|
104 <dt><i>vcs</i></dt> |
|
105 <dd> |
|
106 reference to the vcs object |
|
107 </dd><dt><i>extension</i></dt> |
|
108 <dd> |
|
109 reference to the extension module (Queues) |
|
110 </dd><dt><i>patchesList</i></dt> |
|
111 <dd> |
|
112 list of patches (list of strings) |
|
113 </dd><dt><i>parent</i></dt> |
|
114 <dd> |
|
115 reference to the parent widget (QWidget) |
|
116 </dd> |
|
117 </dl><a NAME="HgQueuesDefineGuardsDialog.__applyGuards" ID="HgQueuesDefineGuardsDialog.__applyGuards"></a> |
|
118 <h4>HgQueuesDefineGuardsDialog.__applyGuards</h4> |
|
119 <b>__applyGuards</b>(<i></i>) |
|
120 <p> |
|
121 Private slot to apply the defined guards to the current patch. |
|
122 </p><a NAME="HgQueuesDefineGuardsDialog.__getGuard" ID="HgQueuesDefineGuardsDialog.__getGuard"></a> |
|
123 <h4>HgQueuesDefineGuardsDialog.__getGuard</h4> |
|
124 <b>__getGuard</b>(<i>guard</i>) |
|
125 <p> |
|
126 Private method to get a reference to a named guard. |
|
127 </p><dl> |
|
128 <dt><i>guard</i></dt> |
|
129 <dd> |
|
130 name of the guard (string) |
|
131 </dd> |
|
132 </dl><dl> |
|
133 <dt>Returns:</dt> |
|
134 <dd> |
|
135 reference to the guard item (QListWidgetItem) |
|
136 </dd> |
|
137 </dl><a NAME="HgQueuesDefineGuardsDialog.closeEvent" ID="HgQueuesDefineGuardsDialog.closeEvent"></a> |
|
138 <h4>HgQueuesDefineGuardsDialog.closeEvent</h4> |
|
139 <b>closeEvent</b>(<i>e</i>) |
|
140 <p> |
|
141 Protected slot implementing a close event handler. |
|
142 </p><dl> |
|
143 <dt><i>e</i></dt> |
|
144 <dd> |
|
145 close event (QCloseEvent) |
|
146 </dd> |
|
147 </dl><a NAME="HgQueuesDefineGuardsDialog.on_addButton_clicked" ID="HgQueuesDefineGuardsDialog.on_addButton_clicked"></a> |
|
148 <h4>HgQueuesDefineGuardsDialog.on_addButton_clicked</h4> |
|
149 <b>on_addButton_clicked</b>(<i></i>) |
|
150 <p> |
|
151 Private slot to add a guard definition to the list or change it. |
|
152 </p><a NAME="HgQueuesDefineGuardsDialog.on_buttonBox_clicked" ID="HgQueuesDefineGuardsDialog.on_buttonBox_clicked"></a> |
|
153 <h4>HgQueuesDefineGuardsDialog.on_buttonBox_clicked</h4> |
|
154 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
155 <p> |
|
156 Private slot called by a button of the button box clicked. |
|
157 </p><dl> |
|
158 <dt><i>button</i></dt> |
|
159 <dd> |
|
160 button that was clicked (QAbstractButton) |
|
161 </dd> |
|
162 </dl><a NAME="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged" ID="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged"></a> |
|
163 <h4>HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged</h4> |
|
164 <b>on_guardCombo_editTextChanged</b>(<i>txt</i>) |
|
165 <p> |
|
166 Private slot to handle changes of the text of the guard combo. |
|
167 </p><dl> |
|
168 <dt><i>txt</i></dt> |
|
169 <dd> |
|
170 contents of the guard combo line edit (string) |
|
171 </dd> |
|
172 </dl><a NAME="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged" ID="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged"></a> |
|
173 <h4>HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged</h4> |
|
174 <b>on_guardsList_itemSelectionChanged</b>(<i></i>) |
|
175 <p> |
|
176 Private slot to handle changes of the selection of guards. |
|
177 </p><a NAME="HgQueuesDefineGuardsDialog.on_patchSelector_activated" ID="HgQueuesDefineGuardsDialog.on_patchSelector_activated"></a> |
|
178 <h4>HgQueuesDefineGuardsDialog.on_patchSelector_activated</h4> |
|
179 <b>on_patchSelector_activated</b>(<i>patch</i>) |
|
180 <p> |
|
181 Private slot to get the list of guards defined for the given patch |
|
182 name. |
|
183 </p><dl> |
|
184 <dt><i>patch</i></dt> |
|
185 <dd> |
|
186 selected patch name (empty for current patch) |
|
187 </dd> |
|
188 </dl><a NAME="HgQueuesDefineGuardsDialog.on_removeButton_clicked" ID="HgQueuesDefineGuardsDialog.on_removeButton_clicked"></a> |
|
189 <h4>HgQueuesDefineGuardsDialog.on_removeButton_clicked</h4> |
|
190 <b>on_removeButton_clicked</b>(<i></i>) |
|
191 <p> |
|
192 Private slot to remove guard definitions from the list. |
|
193 </p><a NAME="HgQueuesDefineGuardsDialog.start" ID="HgQueuesDefineGuardsDialog.start"></a> |
|
194 <h4>HgQueuesDefineGuardsDialog.start</h4> |
|
195 <b>start</b>(<i>path</i>) |
|
196 <p> |
|
197 Public slot to start the list command. |
|
198 </p><dl> |
|
199 <dt><i>path</i></dt> |
|
200 <dd> |
|
201 name of directory to be listed (string) |
|
202 </dd> |
|
203 </dl> |
|
204 <div align="right"><a href="#top">Up</a></div> |
|
205 <hr /> |
|
206 </body></html> |