Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarkDialog.html

changeset 1020
adf7e95f05e7
child 1228
7afaf2fca55b
equal deleted inserted replaced
1019:d8a9697f78d1 1020:adf7e95f05e7
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.BookmarksExtension.HgBookmarkDialog</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.BookmarksExtension.HgBookmarkDialog</h1>
24 <p>
25 Module implementing the bookmark dialog.
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="#HgBookmarkDialog">HgBookmarkDialog</a></td>
35 <td>Class mplementing the bookmark dialog.</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="HgBookmarkDialog" ID="HgBookmarkDialog"></a>
44 <h2>HgBookmarkDialog</h2>
45 <p>
46 Class mplementing the bookmark dialog.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_HgBookmarkDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>DEFINE_MODE</td></tr><tr><td>MOVE_MODE</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgBookmarkDialog.__init__">HgBookmarkDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgBookmarkDialog.__updateBookmarksCombo">__updateBookmarksCombo</a></td>
61 <td>Private slot to update the bookmarks combo.</td>
62 </tr><tr>
63 <td><a href="#HgBookmarkDialog.__updateOK">__updateOK</a></td>
64 <td>Private slot to update the OK button.</td>
65 </tr><tr>
66 <td><a href="#HgBookmarkDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td>
68 </tr><tr>
69 <td><a href="#HgBookmarkDialog.on_bookmarkButton_toggled">on_bookmarkButton_toggled</a></td>
70 <td>Private slot to handle changes of the Bookmark select button.</td>
71 </tr><tr>
72 <td><a href="#HgBookmarkDialog.on_bookmarkCombo_editTextChanged">on_bookmarkCombo_editTextChanged</a></td>
73 <td>Private slot to handle changes of the Bookmark combo.</td>
74 </tr><tr>
75 <td><a href="#HgBookmarkDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
76 <td>Private slot to handle changes of the Branch select button.</td>
77 </tr><tr>
78 <td><a href="#HgBookmarkDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
79 <td>Private slot to handle changes of the Branch combo.</td>
80 </tr><tr>
81 <td><a href="#HgBookmarkDialog.on_idButton_toggled">on_idButton_toggled</a></td>
82 <td>Private slot to handle changes of the ID select button.</td>
83 </tr><tr>
84 <td><a href="#HgBookmarkDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td>
85 <td>Private slot to handle changes of the ID edit.</td>
86 </tr><tr>
87 <td><a href="#HgBookmarkDialog.on_nameCombo_activated">on_nameCombo_activated</a></td>
88 <td>Private slot to handle changes of the selected bookmark name.</td>
89 </tr><tr>
90 <td><a href="#HgBookmarkDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
91 <td>Private slot to handle changes of the bookmark name.</td>
92 </tr><tr>
93 <td><a href="#HgBookmarkDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
94 <td>Private slot to handle changes of the Tag select button.</td>
95 </tr><tr>
96 <td><a href="#HgBookmarkDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
97 <td>Private slot to handle changes of the Tag combo.</td>
98 </tr>
99 </table>
100 <a NAME="HgBookmarkDialog.__init__" ID="HgBookmarkDialog.__init__"></a>
101 <h4>HgBookmarkDialog (Constructor)</h4>
102 <b>HgBookmarkDialog</b>(<i>mode, tagsList, branchesList, bookmarksList, parent=None</i>)
103 <p>
104 Constructor
105 </p><dl>
106 <dt><i>mode</i></dt>
107 <dd>
108 of the dialog (integer)
109 </dd><dt><i>tagsList</i></dt>
110 <dd>
111 list of tags (list of strings)
112 </dd><dt><i>branchesList</i></dt>
113 <dd>
114 list of branches (list of strings)
115 </dd><dt><i>bookmarksList</i></dt>
116 <dd>
117 list of bookmarks (list of strings)
118 </dd><dt><i>parent</i></dt>
119 <dd>
120 reference to the parent widget (QWidget)
121 </dd>
122 </dl><a NAME="HgBookmarkDialog.__updateBookmarksCombo" ID="HgBookmarkDialog.__updateBookmarksCombo"></a>
123 <h4>HgBookmarkDialog.__updateBookmarksCombo</h4>
124 <b>__updateBookmarksCombo</b>(<i></i>)
125 <p>
126 Private slot to update the bookmarks combo.
127 </p><a NAME="HgBookmarkDialog.__updateOK" ID="HgBookmarkDialog.__updateOK"></a>
128 <h4>HgBookmarkDialog.__updateOK</h4>
129 <b>__updateOK</b>(<i></i>)
130 <p>
131 Private slot to update the OK button.
132 </p><a NAME="HgBookmarkDialog.getData" ID="HgBookmarkDialog.getData"></a>
133 <h4>HgBookmarkDialog.getData</h4>
134 <b>getData</b>(<i></i>)
135 <p>
136 Public method to retrieve the entered data.
137 </p><dl>
138 <dt>Returns:</dt>
139 <dd>
140 tuple naming the revision and the bookmark name
141 (string, string)
142 </dd>
143 </dl><a NAME="HgBookmarkDialog.on_bookmarkButton_toggled" ID="HgBookmarkDialog.on_bookmarkButton_toggled"></a>
144 <h4>HgBookmarkDialog.on_bookmarkButton_toggled</h4>
145 <b>on_bookmarkButton_toggled</b>(<i>checked</i>)
146 <p>
147 Private slot to handle changes of the Bookmark select button.
148 </p><dl>
149 <dt><i>checked</i></dt>
150 <dd>
151 state of the button (boolean)
152 </dd>
153 </dl><a NAME="HgBookmarkDialog.on_bookmarkCombo_editTextChanged" ID="HgBookmarkDialog.on_bookmarkCombo_editTextChanged"></a>
154 <h4>HgBookmarkDialog.on_bookmarkCombo_editTextChanged</h4>
155 <b>on_bookmarkCombo_editTextChanged</b>(<i>txt</i>)
156 <p>
157 Private slot to handle changes of the Bookmark combo.
158 </p><dl>
159 <dt><i>txt</i></dt>
160 <dd>
161 text of the combo (string)
162 </dd>
163 </dl><a NAME="HgBookmarkDialog.on_branchButton_toggled" ID="HgBookmarkDialog.on_branchButton_toggled"></a>
164 <h4>HgBookmarkDialog.on_branchButton_toggled</h4>
165 <b>on_branchButton_toggled</b>(<i>checked</i>)
166 <p>
167 Private slot to handle changes of the Branch select button.
168 </p><dl>
169 <dt><i>checked</i></dt>
170 <dd>
171 state of the button (boolean)
172 </dd>
173 </dl><a NAME="HgBookmarkDialog.on_branchCombo_editTextChanged" ID="HgBookmarkDialog.on_branchCombo_editTextChanged"></a>
174 <h4>HgBookmarkDialog.on_branchCombo_editTextChanged</h4>
175 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
176 <p>
177 Private slot to handle changes of the Branch combo.
178 </p><dl>
179 <dt><i>txt</i></dt>
180 <dd>
181 text of the combo (string)
182 </dd>
183 </dl><a NAME="HgBookmarkDialog.on_idButton_toggled" ID="HgBookmarkDialog.on_idButton_toggled"></a>
184 <h4>HgBookmarkDialog.on_idButton_toggled</h4>
185 <b>on_idButton_toggled</b>(<i>checked</i>)
186 <p>
187 Private slot to handle changes of the ID select button.
188 </p><dl>
189 <dt><i>checked</i></dt>
190 <dd>
191 state of the button (boolean)
192 </dd>
193 </dl><a NAME="HgBookmarkDialog.on_idEdit_textChanged" ID="HgBookmarkDialog.on_idEdit_textChanged"></a>
194 <h4>HgBookmarkDialog.on_idEdit_textChanged</h4>
195 <b>on_idEdit_textChanged</b>(<i>txt</i>)
196 <p>
197 Private slot to handle changes of the ID edit.
198 </p><dl>
199 <dt><i>txt</i></dt>
200 <dd>
201 text of the edit (string)
202 </dd>
203 </dl><a NAME="HgBookmarkDialog.on_nameCombo_activated" ID="HgBookmarkDialog.on_nameCombo_activated"></a>
204 <h4>HgBookmarkDialog.on_nameCombo_activated</h4>
205 <b>on_nameCombo_activated</b>(<i>txt</i>)
206 <p>
207 Private slot to handle changes of the selected bookmark name.
208 </p><a NAME="HgBookmarkDialog.on_nameEdit_textChanged" ID="HgBookmarkDialog.on_nameEdit_textChanged"></a>
209 <h4>HgBookmarkDialog.on_nameEdit_textChanged</h4>
210 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
211 <p>
212 Private slot to handle changes of the bookmark name.
213 </p><dl>
214 <dt><i>txt</i></dt>
215 <dd>
216 text of the edit (string)
217 </dd>
218 </dl><a NAME="HgBookmarkDialog.on_tagButton_toggled" ID="HgBookmarkDialog.on_tagButton_toggled"></a>
219 <h4>HgBookmarkDialog.on_tagButton_toggled</h4>
220 <b>on_tagButton_toggled</b>(<i>checked</i>)
221 <p>
222 Private slot to handle changes of the Tag select button.
223 </p><dl>
224 <dt><i>checked</i></dt>
225 <dd>
226 state of the button (boolean)
227 </dd>
228 </dl><a NAME="HgBookmarkDialog.on_tagCombo_editTextChanged" ID="HgBookmarkDialog.on_tagCombo_editTextChanged"></a>
229 <h4>HgBookmarkDialog.on_tagCombo_editTextChanged</h4>
230 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
231 <p>
232 Private slot to handle changes of the Tag combo.
233 </p><dl>
234 <dt><i>txt</i></dt>
235 <dd>
236 text of the combo (string)
237 </dd>
238 </dl>
239 <div align="right"><a href="#top">Up</a></div>
240 <hr />
241 </body></html>

eric ide

mercurial