Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksMenu.html

eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksMenu.html

changeset 6942
2602857055c5
parent 6123
39cd368143db
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Bookmarks.BookmarksMenu</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.Helpviewer.Bookmarks.BookmarksMenu</h1>
23 <p>
24 Module implementing the bookmarks menu.
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="#BookmarksMenu">BookmarksMenu</a></td>
34 <td>Class implementing the bookmarks menu base class.</td>
35 </tr><tr>
36 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td>
37 <td>Class implementing a dynamically populated menu for bookmarks.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a>
46 <h2>BookmarksMenu</h2>
47 <p>
48 Class implementing the bookmarks menu base class.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>newUrl(QUrl, str)</dt>
52 <dd>
53 emitted to open a URL with the given title in a
54 new tab
55 </dd><dt>openUrl(QUrl, str)</dt>
56 <dd>
57 emitted to open a URL with the given title in
58 the current tab
59 </dd>
60 </dl>
61 <h3>Derived from</h3>
62 E5ModelMenu
63 <h3>Class Attributes</h3>
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Class Methods</h3>
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72 <table>
73 <tr>
74 <td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td>
75 <td>Constructor</td>
76 </tr><tr>
77 <td><a href="#BookmarksMenu.__activated">__activated</a></td>
78 <td>Private slot handling the activated signal.</td>
79 </tr><tr>
80 <td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td>
81 <td>Private slot to handle the context menu request.</td>
82 </tr><tr>
83 <td><a href="#BookmarksMenu.__edit">__edit</a></td>
84 <td>Private slot to edit a bookmarks properties.</td>
85 </tr><tr>
86 <td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td>
87 <td>Private slot to open a bookmark in the current browser tab.</td>
88 </tr><tr>
89 <td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td>
90 <td>Private slot to open a bookmark in a new browser tab.</td>
91 </tr><tr>
92 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td>
93 <td>Private slot to remove a bookmark.</td>
94 </tr><tr>
95 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td>
96 <td>Public method to get the menu that is used to populate sub menu's.</td>
97 </tr><tr>
98 <td><a href="#BookmarksMenu.openAll">openAll</a></td>
99 <td>Public slot to open all the menu's items.</td>
100 </tr><tr>
101 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td>
102 <td>Public method to add any actions after the tree.</td>
103 </tr>
104 </table>
105 <h3>Static Methods</h3>
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a>
110 <h4>BookmarksMenu (Constructor)</h4>
111 <b>BookmarksMenu</b>(<i>parent=None</i>)
112 <p>
113 Constructor
114 </p><dl>
115 <dt><i>parent</i></dt>
116 <dd>
117 reference to the parent widget (QWidget)
118 </dd>
119 </dl><a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a>
120 <h4>BookmarksMenu.__activated</h4>
121 <b>__activated</b>(<i>idx</i>)
122 <p>
123 Private slot handling the activated signal.
124 </p><dl>
125 <dt><i>idx</i></dt>
126 <dd>
127 index of the activated item (QModelIndex)
128 </dd>
129 </dl><a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a>
130 <h4>BookmarksMenu.__contextMenuRequested</h4>
131 <b>__contextMenuRequested</b>(<i>pos</i>)
132 <p>
133 Private slot to handle the context menu request.
134 </p><dl>
135 <dt><i>pos</i></dt>
136 <dd>
137 position the context menu shall be shown (QPoint)
138 </dd>
139 </dl><a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a>
140 <h4>BookmarksMenu.__edit</h4>
141 <b>__edit</b>(<i>act</i>)
142 <p>
143 Private slot to edit a bookmarks properties.
144 </p><dl>
145 <dt><i>act</i> (QAction)</dt>
146 <dd>
147 reference to the triggering action
148 </dd>
149 </dl><a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a>
150 <h4>BookmarksMenu.__openBookmark</h4>
151 <b>__openBookmark</b>(<i>act</i>)
152 <p>
153 Private slot to open a bookmark in the current browser tab.
154 </p><dl>
155 <dt><i>act</i> (QAction)</dt>
156 <dd>
157 reference to the triggering action
158 </dd>
159 </dl><a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a>
160 <h4>BookmarksMenu.__openBookmarkInNewTab</h4>
161 <b>__openBookmarkInNewTab</b>(<i>act</i>)
162 <p>
163 Private slot to open a bookmark in a new browser tab.
164 </p><dl>
165 <dt><i>act</i> (QAction)</dt>
166 <dd>
167 reference to the triggering action
168 </dd>
169 </dl><a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a>
170 <h4>BookmarksMenu.__removeBookmark</h4>
171 <b>__removeBookmark</b>(<i>act</i>)
172 <p>
173 Private slot to remove a bookmark.
174 </p><dl>
175 <dt><i>act</i> (QAction)</dt>
176 <dd>
177 reference to the triggering action
178 </dd>
179 </dl><a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a>
180 <h4>BookmarksMenu.createBaseMenu</h4>
181 <b>createBaseMenu</b>(<i></i>)
182 <p>
183 Public method to get the menu that is used to populate sub menu's.
184 </p><dl>
185 <dt>Returns:</dt>
186 <dd>
187 reference to the menu (BookmarksMenu)
188 </dd>
189 </dl><a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a>
190 <h4>BookmarksMenu.openAll</h4>
191 <b>openAll</b>(<i>act</i>)
192 <p>
193 Public slot to open all the menu's items.
194 </p><dl>
195 <dt><i>act</i> (QAction)</dt>
196 <dd>
197 reference to the action object
198 </dd>
199 </dl><a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a>
200 <h4>BookmarksMenu.postPopulated</h4>
201 <b>postPopulated</b>(<i></i>)
202 <p>
203 Public method to add any actions after the tree.
204 </p>
205 <div align="right"><a href="#top">Up</a></div>
206 <hr /><hr />
207 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a>
208 <h2>BookmarksMenuBarMenu</h2>
209 <p>
210 Class implementing a dynamically populated menu for bookmarks.
211 </p><h3>Signals</h3>
212 <dl>
213 <dt>openUrl(QUrl, str)</dt>
214 <dd>
215 emitted to open a URL with the given title in
216 the current tab
217 </dd>
218 </dl>
219 <h3>Derived from</h3>
220 BookmarksMenu
221 <h3>Class Attributes</h3>
222 <table>
223 <tr><td>None</td></tr>
224 </table>
225 <h3>Class Methods</h3>
226 <table>
227 <tr><td>None</td></tr>
228 </table>
229 <h3>Methods</h3>
230 <table>
231 <tr>
232 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td>
233 <td>Constructor</td>
234 </tr><tr>
235 <td><a href="#BookmarksMenuBarMenu.__defaultBookmarkTriggered">__defaultBookmarkTriggered</a></td>
236 <td>Private slot handling the default bookmark menu entries.</td>
237 </tr><tr>
238 <td><a href="#BookmarksMenuBarMenu.postPopulated">postPopulated</a></td>
239 <td>Public method to add any actions after the tree.</td>
240 </tr><tr>
241 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td>
242 <td>Public method to add any actions before the tree.</td>
243 </tr><tr>
244 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td>
245 <td>Public method to set the list of actions that should appear first in the menu.</td>
246 </tr>
247 </table>
248 <h3>Static Methods</h3>
249 <table>
250 <tr><td>None</td></tr>
251 </table>
252 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a>
253 <h4>BookmarksMenuBarMenu (Constructor)</h4>
254 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>)
255 <p>
256 Constructor
257 </p><dl>
258 <dt><i>parent</i></dt>
259 <dd>
260 reference to the parent widget (QWidget)
261 </dd>
262 </dl><a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a>
263 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4>
264 <b>__defaultBookmarkTriggered</b>(<i>act</i>)
265 <p>
266 Private slot handling the default bookmark menu entries.
267 </p><dl>
268 <dt><i>act</i> (QAction)</dt>
269 <dd>
270 reference to the action object
271 </dd>
272 </dl><a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a>
273 <h4>BookmarksMenuBarMenu.postPopulated</h4>
274 <b>postPopulated</b>(<i></i>)
275 <p>
276 Public method to add any actions after the tree.
277 </p><a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a>
278 <h4>BookmarksMenuBarMenu.prePopulated</h4>
279 <b>prePopulated</b>(<i></i>)
280 <p>
281 Public method to add any actions before the tree.
282 </p><dl>
283 <dt>Returns:</dt>
284 <dd>
285 flag indicating if any actions were added (boolean)
286 </dd>
287 </dl><a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a>
288 <h4>BookmarksMenuBarMenu.setInitialActions</h4>
289 <b>setInitialActions</b>(<i>actions</i>)
290 <p>
291 Public method to set the list of actions that should appear first in
292 the menu.
293 </p><dl>
294 <dt><i>actions</i></dt>
295 <dd>
296 list of initial actions (list of QAction)
297 </dd>
298 </dl>
299 <div align="right"><a href="#top">Up</a></div>
300 <hr />
301 </body></html>

Mercurial Repository: eric

eric ide

mercurial