Mercurial Repositories > eric / file comparison

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

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

changeset 4918
71caf42a13d8
child 5015
ca1d44f0f6b2
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.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.WebBrowser.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.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td>
93 <td>Private slot to open a bookmark in a new window.</td>
94 </tr><tr>
95 <td><a href="#BookmarksMenu.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td>
96 <td>Private slot to open a bookmark in a new private window.</td>
97 </tr><tr>
98 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td>
99 <td>Private slot to remove a bookmark.</td>
100 </tr><tr>
101 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td>
102 <td>Public method to get the menu that is used to populate sub menu's.</td>
103 </tr><tr>
104 <td><a href="#BookmarksMenu.openAll">openAll</a></td>
105 <td>Public slot to open all the menu's items.</td>
106 </tr><tr>
107 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td>
108 <td>Public method to add any actions after the tree.</td>
109 </tr>
110 </table>
111 <h3>Static Methods</h3>
112 <table>
113 <tr><td>None</td></tr>
114 </table>
115 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a>
116 <h4>BookmarksMenu (Constructor)</h4>
117 <b>BookmarksMenu</b>(<i>parent=None</i>)
118 <p>
119 Constructor
120 </p><dl>
121 <dt><i>parent</i></dt>
122 <dd>
123 reference to the parent widget (QWidget)
124 </dd>
125 </dl><a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a>
126 <h4>BookmarksMenu.__activated</h4>
127 <b>__activated</b>(<i>idx</i>)
128 <p>
129 Private slot handling the activated signal.
130 </p><dl>
131 <dt><i>idx</i></dt>
132 <dd>
133 index of the activated item (QModelIndex)
134 </dd>
135 </dl><a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a>
136 <h4>BookmarksMenu.__contextMenuRequested</h4>
137 <b>__contextMenuRequested</b>(<i>pos</i>)
138 <p>
139 Private slot to handle the context menu request.
140 </p><dl>
141 <dt><i>pos</i></dt>
142 <dd>
143 position the context menu shall be shown (QPoint)
144 </dd>
145 </dl><a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a>
146 <h4>BookmarksMenu.__edit</h4>
147 <b>__edit</b>(<i></i>)
148 <p>
149 Private slot to edit a bookmarks properties.
150 </p><a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a>
151 <h4>BookmarksMenu.__openBookmark</h4>
152 <b>__openBookmark</b>(<i></i>)
153 <p>
154 Private slot to open a bookmark in the current browser tab.
155 </p><a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a>
156 <h4>BookmarksMenu.__openBookmarkInNewTab</h4>
157 <b>__openBookmarkInNewTab</b>(<i></i>)
158 <p>
159 Private slot to open a bookmark in a new browser tab.
160 </p><a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a>
161 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4>
162 <b>__openBookmarkInNewWindow</b>(<i></i>)
163 <p>
164 Private slot to open a bookmark in a new window.
165 </p><a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a>
166 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4>
167 <b>__openBookmarkInPrivateWindow</b>(<i></i>)
168 <p>
169 Private slot to open a bookmark in a new private window.
170 </p><a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a>
171 <h4>BookmarksMenu.__removeBookmark</h4>
172 <b>__removeBookmark</b>(<i></i>)
173 <p>
174 Private slot to remove a bookmark.
175 </p><a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a>
176 <h4>BookmarksMenu.createBaseMenu</h4>
177 <b>createBaseMenu</b>(<i></i>)
178 <p>
179 Public method to get the menu that is used to populate sub menu's.
180 </p><dl>
181 <dt>Returns:</dt>
182 <dd>
183 reference to the menu (BookmarksMenu)
184 </dd>
185 </dl><a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a>
186 <h4>BookmarksMenu.openAll</h4>
187 <b>openAll</b>(<i></i>)
188 <p>
189 Public slot to open all the menu's items.
190 </p><a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a>
191 <h4>BookmarksMenu.postPopulated</h4>
192 <b>postPopulated</b>(<i></i>)
193 <p>
194 Public method to add any actions after the tree.
195 </p>
196 <div align="right"><a href="#top">Up</a></div>
197 <hr /><hr />
198 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a>
199 <h2>BookmarksMenuBarMenu</h2>
200 <p>
201 Class implementing a dynamically populated menu for bookmarks.
202 </p><h3>Signals</h3>
203 <dl>
204 <dt>openUrl(QUrl, str)</dt>
205 <dd>
206 emitted to open a URL with the given title in
207 the current tab
208 </dd>
209 </dl>
210 <h3>Derived from</h3>
211 BookmarksMenu
212 <h3>Class Attributes</h3>
213 <table>
214 <tr><td>None</td></tr>
215 </table>
216 <h3>Class Methods</h3>
217 <table>
218 <tr><td>None</td></tr>
219 </table>
220 <h3>Methods</h3>
221 <table>
222 <tr>
223 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td>
224 <td>Constructor</td>
225 </tr><tr>
226 <td><a href="#BookmarksMenuBarMenu.__defaultBookmarkTriggered">__defaultBookmarkTriggered</a></td>
227 <td>Private slot handling the default bookmark menu entries.</td>
228 </tr><tr>
229 <td><a href="#BookmarksMenuBarMenu.postPopulated">postPopulated</a></td>
230 <td>Public method to add any actions after the tree.</td>
231 </tr><tr>
232 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td>
233 <td>Public method to add any actions before the tree.</td>
234 </tr><tr>
235 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td>
236 <td>Public method to set the list of actions that should appear first in the menu.</td>
237 </tr>
238 </table>
239 <h3>Static Methods</h3>
240 <table>
241 <tr><td>None</td></tr>
242 </table>
243 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a>
244 <h4>BookmarksMenuBarMenu (Constructor)</h4>
245 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>)
246 <p>
247 Constructor
248 </p><dl>
249 <dt><i>parent</i></dt>
250 <dd>
251 reference to the parent widget (QWidget)
252 </dd>
253 </dl><a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a>
254 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4>
255 <b>__defaultBookmarkTriggered</b>(<i></i>)
256 <p>
257 Private slot handling the default bookmark menu entries.
258 </p><a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a>
259 <h4>BookmarksMenuBarMenu.postPopulated</h4>
260 <b>postPopulated</b>(<i></i>)
261 <p>
262 Public method to add any actions after the tree.
263 </p><a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a>
264 <h4>BookmarksMenuBarMenu.prePopulated</h4>
265 <b>prePopulated</b>(<i></i>)
266 <p>
267 Public method to add any actions before the tree.
268 </p><dl>
269 <dt>Returns:</dt>
270 <dd>
271 flag indicating if any actions were added (boolean)
272 </dd>
273 </dl><a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a>
274 <h4>BookmarksMenuBarMenu.setInitialActions</h4>
275 <b>setInitialActions</b>(<i>actions</i>)
276 <p>
277 Public method to set the list of actions that should appear first in
278 the menu.
279 </p><dl>
280 <dt><i>actions</i></dt>
281 <dd>
282 list of initial actions (list of QAction)
283 </dd>
284 </dl>
285 <div align="right"><a href="#top">Up</a></div>
286 <hr />
287 </body></html>

Mercurial Repository: eric

eric ide

mercurial