Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog.html

changeset 1048
0cfd237feaf7
child 1228
7afaf2fca55b
equal deleted inserted replaced
1047:b41a36b201e4 1048:0cfd237feaf7
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog</h1>
24 <p>
25 Module implementing a dialog to define guards for patches.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HgQueuesDefineGuardsDialog">HgQueuesDefineGuardsDialog</a></td>
35 <td>Class implementing a dialog to define guards for patches.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="HgQueuesDefineGuardsDialog" ID="HgQueuesDefineGuardsDialog"></a>
44 <h2>HgQueuesDefineGuardsDialog</h2>
45 <p>
46 Class implementing a dialog to define guards for patches.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_HgQueuesDefineGuardsDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgQueuesDefineGuardsDialog.__init__">HgQueuesDefineGuardsDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgQueuesDefineGuardsDialog.__applyGuards">__applyGuards</a></td>
61 <td>Private slot to apply the defined guards to the current patch.</td>
62 </tr><tr>
63 <td><a href="#HgQueuesDefineGuardsDialog.__getGuard">__getGuard</a></td>
64 <td>Private method to get a reference to a named guard.</td>
65 </tr><tr>
66 <td><a href="#HgQueuesDefineGuardsDialog.closeEvent">closeEvent</a></td>
67 <td>Private slot implementing a close event handler.</td>
68 </tr><tr>
69 <td><a href="#HgQueuesDefineGuardsDialog.on_addButton_clicked">on_addButton_clicked</a></td>
70 <td>Private slot to add a guard definition to the list or change it.</td>
71 </tr><tr>
72 <td><a href="#HgQueuesDefineGuardsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
73 <td>Private slot called by a button of the button box clicked.</td>
74 </tr><tr>
75 <td><a href="#HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged">on_guardCombo_editTextChanged</a></td>
76 <td>Private slot to handle changes of the text of the guard combo.</td>
77 </tr><tr>
78 <td><a href="#HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged">on_guardsList_itemSelectionChanged</a></td>
79 <td>Private slot to handle changes of the selection of guards.</td>
80 </tr><tr>
81 <td><a href="#HgQueuesDefineGuardsDialog.on_patchSelector_activated">on_patchSelector_activated</a></td>
82 <td>Private slot to get the list of guards defined for the given patch name.</td>
83 </tr><tr>
84 <td><a href="#HgQueuesDefineGuardsDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
85 <td>Private slot to remove guard definitions from the list.</td>
86 </tr><tr>
87 <td><a href="#HgQueuesDefineGuardsDialog.start">start</a></td>
88 <td>Public slot to start the list command.</td>
89 </tr>
90 </table>
91 <a NAME="HgQueuesDefineGuardsDialog.__init__" ID="HgQueuesDefineGuardsDialog.__init__"></a>
92 <h4>HgQueuesDefineGuardsDialog (Constructor)</h4>
93 <b>HgQueuesDefineGuardsDialog</b>(<i>vcs, extension, patchesList, parent=None</i>)
94 <p>
95 Constructor
96 </p><dl>
97 <dt><i>vcs</i></dt>
98 <dd>
99 reference to the vcs object
100 </dd><dt><i>extension</i></dt>
101 <dd>
102 reference to the extension module (Queues)
103 </dd><dt><i>patchesList</i></dt>
104 <dd>
105 list of patches (list of strings)
106 </dd><dt><i>parent</i></dt>
107 <dd>
108 reference to the parent widget (QWidget)
109 </dd>
110 </dl><a NAME="HgQueuesDefineGuardsDialog.__applyGuards" ID="HgQueuesDefineGuardsDialog.__applyGuards"></a>
111 <h4>HgQueuesDefineGuardsDialog.__applyGuards</h4>
112 <b>__applyGuards</b>(<i></i>)
113 <p>
114 Private slot to apply the defined guards to the current patch.
115 </p><a NAME="HgQueuesDefineGuardsDialog.__getGuard" ID="HgQueuesDefineGuardsDialog.__getGuard"></a>
116 <h4>HgQueuesDefineGuardsDialog.__getGuard</h4>
117 <b>__getGuard</b>(<i>guard</i>)
118 <p>
119 Private method to get a reference to a named guard.
120 </p><dl>
121 <dt><i>guard</i></dt>
122 <dd>
123 name of the guard (string)
124 </dd>
125 </dl><dl>
126 <dt>Returns:</dt>
127 <dd>
128 reference to the guard item (QListWidgetItem)
129 </dd>
130 </dl><a NAME="HgQueuesDefineGuardsDialog.closeEvent" ID="HgQueuesDefineGuardsDialog.closeEvent"></a>
131 <h4>HgQueuesDefineGuardsDialog.closeEvent</h4>
132 <b>closeEvent</b>(<i>e</i>)
133 <p>
134 Private slot implementing a close event handler.
135 </p><dl>
136 <dt><i>e</i></dt>
137 <dd>
138 close event (QCloseEvent)
139 </dd>
140 </dl><a NAME="HgQueuesDefineGuardsDialog.on_addButton_clicked" ID="HgQueuesDefineGuardsDialog.on_addButton_clicked"></a>
141 <h4>HgQueuesDefineGuardsDialog.on_addButton_clicked</h4>
142 <b>on_addButton_clicked</b>(<i></i>)
143 <p>
144 Private slot to add a guard definition to the list or change it.
145 </p><a NAME="HgQueuesDefineGuardsDialog.on_buttonBox_clicked" ID="HgQueuesDefineGuardsDialog.on_buttonBox_clicked"></a>
146 <h4>HgQueuesDefineGuardsDialog.on_buttonBox_clicked</h4>
147 <b>on_buttonBox_clicked</b>(<i>button</i>)
148 <p>
149 Private slot called by a button of the button box clicked.
150 </p><dl>
151 <dt><i>button</i></dt>
152 <dd>
153 button that was clicked (QAbstractButton)
154 </dd>
155 </dl><a NAME="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged" ID="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged"></a>
156 <h4>HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged</h4>
157 <b>on_guardCombo_editTextChanged</b>(<i>txt</i>)
158 <p>
159 Private slot to handle changes of the text of the guard combo.
160 </p><dl>
161 <dt><i>txt</i></dt>
162 <dd>
163 contents of the guard combo line edit (string)
164 </dd>
165 </dl><a NAME="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged" ID="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged"></a>
166 <h4>HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged</h4>
167 <b>on_guardsList_itemSelectionChanged</b>(<i></i>)
168 <p>
169 Private slot to handle changes of the selection of guards.
170 </p><a NAME="HgQueuesDefineGuardsDialog.on_patchSelector_activated" ID="HgQueuesDefineGuardsDialog.on_patchSelector_activated"></a>
171 <h4>HgQueuesDefineGuardsDialog.on_patchSelector_activated</h4>
172 <b>on_patchSelector_activated</b>(<i>patch</i>)
173 <p>
174 Private slot to get the list of guards defined for the given patch name.
175 </p><dl>
176 <dt><i>patch</i></dt>
177 <dd>
178 selected patch name (empty for current patch)
179 </dd>
180 </dl><a NAME="HgQueuesDefineGuardsDialog.on_removeButton_clicked" ID="HgQueuesDefineGuardsDialog.on_removeButton_clicked"></a>
181 <h4>HgQueuesDefineGuardsDialog.on_removeButton_clicked</h4>
182 <b>on_removeButton_clicked</b>(<i></i>)
183 <p>
184 Private slot to remove guard definitions from the list.
185 </p><a NAME="HgQueuesDefineGuardsDialog.start" ID="HgQueuesDefineGuardsDialog.start"></a>
186 <h4>HgQueuesDefineGuardsDialog.start</h4>
187 <b>start</b>(<i>path</i>)
188 <p>
189 Public slot to start the list command.
190 </p><dl>
191 <dt><i>path</i></dt>
192 <dd>
193 name of directory to be listed (string)
194 </dd>
195 </dl>
196 <div align="right"><a href="#top">Up</a></div>
197 <hr />
198 </body></html>

eric ide

mercurial