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

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

eric ide

mercurial