|
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.Helpviewer.Bookmarks.BookmarksMenu</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Helpviewer.Bookmarks.BookmarksMenu</h1> |
|
12 <p> |
|
13 Module implementing the bookmarks menu. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#BookmarksMenu">BookmarksMenu</a></td> |
|
23 <td>Class implementing the bookmarks menu base class.</td> |
|
24 </tr><tr> |
|
25 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td> |
|
26 <td>Class implementing a dynamically populated menu for bookmarks.</td> |
|
27 </tr> |
|
28 </table> |
|
29 <h3>Functions</h3> |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /><hr /> |
|
34 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a> |
|
35 <h2>BookmarksMenu</h2> |
|
36 <p> |
|
37 Class implementing the bookmarks menu base class. |
|
38 </p><h4>Signals</h4> |
|
39 <dl> |
|
40 <dt>newUrl(const QUrl&, const QString&)</dt> |
|
41 <dd> |
|
42 emitted to open a URL in a new tab |
|
43 </dd><dt>openUrl(const QUrl&, const QString&)</dt> |
|
44 <dd> |
|
45 emitted to open a URL in the current |
|
46 tab |
|
47 </dd> |
|
48 </dl> |
|
49 <h3>Derived from</h3> |
|
50 E4ModelMenu |
|
51 <h3>Class Attributes</h3> |
|
52 <table> |
|
53 <tr><td>None</td></tr> |
|
54 </table> |
|
55 <h3>Methods</h3> |
|
56 <table> |
|
57 <tr> |
|
58 <td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr><tr> |
|
61 <td><a href="#BookmarksMenu.__activated">__activated</a></td> |
|
62 <td>Private slot handling the activated signal.</td> |
|
63 </tr><tr> |
|
64 <td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td> |
|
65 <td>Private slot to handle the context menu request.</td> |
|
66 </tr><tr> |
|
67 <td><a href="#BookmarksMenu.__openAll">__openAll</a></td> |
|
68 <td>Private slot to open all the menu's items.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td> |
|
71 <td>Private slot to open a bookmark in the current browser tab.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> |
|
74 <td>Private slot to open a bookmark in a new browser tab.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td> |
|
77 <td>Private slot to remove a bookmark.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td> |
|
80 <td>Public method to get the menu that is used to populate sub menu's.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td> |
|
83 <td>Public method to add any actions after the tree.</td> |
|
84 </tr> |
|
85 </table> |
|
86 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a> |
|
87 <h4>BookmarksMenu (Constructor)</h4> |
|
88 <b>BookmarksMenu</b>(<i>parent = None</i>) |
|
89 <p> |
|
90 Constructor |
|
91 </p><dl> |
|
92 <dt><i>parent</i></dt> |
|
93 <dd> |
|
94 reference to the parent widget (QWidget) |
|
95 </dd> |
|
96 </dl><a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a> |
|
97 <h4>BookmarksMenu.__activated</h4> |
|
98 <b>__activated</b>(<i>idx</i>) |
|
99 <p> |
|
100 Private slot handling the activated signal. |
|
101 </p><dl> |
|
102 <dt><i>idx</i></dt> |
|
103 <dd> |
|
104 index of the activated item (QModelIndex) |
|
105 </dd> |
|
106 </dl><a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a> |
|
107 <h4>BookmarksMenu.__contextMenuRequested</h4> |
|
108 <b>__contextMenuRequested</b>(<i>pos</i>) |
|
109 <p> |
|
110 Private slot to handle the context menu request. |
|
111 </p><dl> |
|
112 <dt><i>pos</i></dt> |
|
113 <dd> |
|
114 position the context menu shall be shown (QPoint) |
|
115 </dd> |
|
116 </dl><a NAME="BookmarksMenu.__openAll" ID="BookmarksMenu.__openAll"></a> |
|
117 <h4>BookmarksMenu.__openAll</h4> |
|
118 <b>__openAll</b>(<i></i>) |
|
119 <p> |
|
120 Private slot to open all the menu's items. |
|
121 </p><a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a> |
|
122 <h4>BookmarksMenu.__openBookmark</h4> |
|
123 <b>__openBookmark</b>(<i></i>) |
|
124 <p> |
|
125 Private slot to open a bookmark in the current browser tab. |
|
126 </p><a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a> |
|
127 <h4>BookmarksMenu.__openBookmarkInNewTab</h4> |
|
128 <b>__openBookmarkInNewTab</b>(<i></i>) |
|
129 <p> |
|
130 Private slot to open a bookmark in a new browser tab. |
|
131 </p><a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a> |
|
132 <h4>BookmarksMenu.__removeBookmark</h4> |
|
133 <b>__removeBookmark</b>(<i></i>) |
|
134 <p> |
|
135 Private slot to remove a bookmark. |
|
136 </p><a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a> |
|
137 <h4>BookmarksMenu.createBaseMenu</h4> |
|
138 <b>createBaseMenu</b>(<i></i>) |
|
139 <p> |
|
140 Public method to get the menu that is used to populate sub menu's. |
|
141 </p><dl> |
|
142 <dt>Returns:</dt> |
|
143 <dd> |
|
144 reference to the menu (BookmarksMenu) |
|
145 </dd> |
|
146 </dl><a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a> |
|
147 <h4>BookmarksMenu.postPopulated</h4> |
|
148 <b>postPopulated</b>(<i></i>) |
|
149 <p> |
|
150 Public method to add any actions after the tree. |
|
151 </p> |
|
152 <div align="right"><a href="#top">Up</a></div> |
|
153 <hr /><hr /> |
|
154 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a> |
|
155 <h2>BookmarksMenuBarMenu</h2> |
|
156 <p> |
|
157 Class implementing a dynamically populated menu for bookmarks. |
|
158 </p> |
|
159 <h3>Derived from</h3> |
|
160 BookmarksMenu |
|
161 <h3>Class Attributes</h3> |
|
162 <table> |
|
163 <tr><td>None</td></tr> |
|
164 </table> |
|
165 <h3>Methods</h3> |
|
166 <table> |
|
167 <tr> |
|
168 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td> |
|
169 <td>Constructor</td> |
|
170 </tr><tr> |
|
171 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td> |
|
172 <td>Public method to add any actions before the tree.</td> |
|
173 </tr><tr> |
|
174 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td> |
|
175 <td>Public method to set the list of actions that should appear first in the menu.</td> |
|
176 </tr> |
|
177 </table> |
|
178 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a> |
|
179 <h4>BookmarksMenuBarMenu (Constructor)</h4> |
|
180 <b>BookmarksMenuBarMenu</b>(<i>parent = None</i>) |
|
181 <p> |
|
182 Constructor |
|
183 </p><dl> |
|
184 <dt><i>parent</i></dt> |
|
185 <dd> |
|
186 reference to the parent widget (QWidget) |
|
187 </dd> |
|
188 </dl><a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a> |
|
189 <h4>BookmarksMenuBarMenu.prePopulated</h4> |
|
190 <b>prePopulated</b>(<i></i>) |
|
191 <p> |
|
192 Public method to add any actions before the tree. |
|
193 </p><dl> |
|
194 <dt>Returns:</dt> |
|
195 <dd> |
|
196 flag indicating if any actions were added (boolean) |
|
197 </dd> |
|
198 </dl><a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a> |
|
199 <h4>BookmarksMenuBarMenu.setInitialActions</h4> |
|
200 <b>setInitialActions</b>(<i>actions</i>) |
|
201 <p> |
|
202 Public method to set the list of actions that should appear first in the menu. |
|
203 </p><dl> |
|
204 <dt><i>actions</i></dt> |
|
205 <dd> |
|
206 list of initial actions (list of QAction) |
|
207 </dd> |
|
208 </dl> |
|
209 <div align="right"><a href="#top">Up</a></div> |
|
210 <hr /> |
|
211 </body></html> |