|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Helpviewer.Bookmarks.BookmarksToolBar</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.BookmarksToolBar</h1> |
|
23 <p> |
|
24 Module implementing a tool bar showing bookmarks. |
|
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="#BookmarksToolBar">BookmarksToolBar</a></td> |
|
34 <td>Class implementing a tool bar showing bookmarks.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="BookmarksToolBar" ID="BookmarksToolBar"></a> |
|
43 <h2>BookmarksToolBar</h2> |
|
44 <p> |
|
45 Class implementing a tool bar showing bookmarks. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>newUrl(QUrl, str)</dt> |
|
49 <dd> |
|
50 emitted to open a URL in a new tab |
|
51 </dd><dt>openUrl(QUrl, str)</dt> |
|
52 <dd> |
|
53 emitted to open a URL in the current tab |
|
54 </dd> |
|
55 </dl> |
|
56 <h3>Derived from</h3> |
|
57 E5ModelToolBar |
|
58 <h3>Class Attributes</h3> |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Methods</h3> |
|
67 <table> |
|
68 <tr> |
|
69 <td><a href="#BookmarksToolBar.__init__">BookmarksToolBar</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#BookmarksToolBar.__bookmarkActivated">__bookmarkActivated</a></td> |
|
73 <td>Private slot handling the activation of a bookmark.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#BookmarksToolBar.__contextMenuRequested">__contextMenuRequested</a></td> |
|
76 <td>Private slot to handle the context menu request.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#BookmarksToolBar.__edit">__edit</a></td> |
|
79 <td>Private slot to edit a bookmarks properties.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#BookmarksToolBar.__newBookmark">__newBookmark</a></td> |
|
82 <td>Private slot to add a new bookmark.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#BookmarksToolBar.__newFolder">__newFolder</a></td> |
|
85 <td>Private slot to add a new bookmarks folder.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#BookmarksToolBar.__openBookmark">__openBookmark</a></td> |
|
88 <td>Private slot to open a bookmark in the current browser tab.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#BookmarksToolBar.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> |
|
91 <td>Private slot to open a bookmark in a new browser tab.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#BookmarksToolBar.__rebuild">__rebuild</a></td> |
|
94 <td>Private slot to rebuild the toolbar.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#BookmarksToolBar.__removeBookmark">__removeBookmark</a></td> |
|
97 <td>Private slot to remove a bookmark.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#BookmarksToolBar._createMenu">_createMenu</a></td> |
|
100 <td>Protected method to create the menu for a tool bar action.</td> |
|
101 </tr> |
|
102 </table> |
|
103 <h3>Static Methods</h3> |
|
104 <table> |
|
105 <tr><td>None</td></tr> |
|
106 </table> |
|
107 <a NAME="BookmarksToolBar.__init__" ID="BookmarksToolBar.__init__"></a> |
|
108 <h4>BookmarksToolBar (Constructor)</h4> |
|
109 <b>BookmarksToolBar</b>(<i>mainWindow, model, parent=None</i>) |
|
110 <p> |
|
111 Constructor |
|
112 </p><dl> |
|
113 <dt><i>mainWindow</i></dt> |
|
114 <dd> |
|
115 reference to the main window (HelpWindow) |
|
116 </dd><dt><i>model</i></dt> |
|
117 <dd> |
|
118 reference to the bookmarks model (BookmarksModel) |
|
119 </dd><dt><i>parent</i></dt> |
|
120 <dd> |
|
121 reference to the parent widget (QWidget) |
|
122 </dd> |
|
123 </dl><a NAME="BookmarksToolBar.__bookmarkActivated" ID="BookmarksToolBar.__bookmarkActivated"></a> |
|
124 <h4>BookmarksToolBar.__bookmarkActivated</h4> |
|
125 <b>__bookmarkActivated</b>(<i>idx</i>) |
|
126 <p> |
|
127 Private slot handling the activation of a bookmark. |
|
128 </p><dl> |
|
129 <dt><i>idx</i></dt> |
|
130 <dd> |
|
131 index of the activated bookmark (QModelIndex) |
|
132 </dd> |
|
133 </dl><a NAME="BookmarksToolBar.__contextMenuRequested" ID="BookmarksToolBar.__contextMenuRequested"></a> |
|
134 <h4>BookmarksToolBar.__contextMenuRequested</h4> |
|
135 <b>__contextMenuRequested</b>(<i>pos</i>) |
|
136 <p> |
|
137 Private slot to handle the context menu request. |
|
138 </p><dl> |
|
139 <dt><i>pos</i></dt> |
|
140 <dd> |
|
141 position the context menu shall be shown (QPoint) |
|
142 </dd> |
|
143 </dl><a NAME="BookmarksToolBar.__edit" ID="BookmarksToolBar.__edit"></a> |
|
144 <h4>BookmarksToolBar.__edit</h4> |
|
145 <b>__edit</b>(<i>act</i>) |
|
146 <p> |
|
147 Private slot to edit a bookmarks properties. |
|
148 </p><dl> |
|
149 <dt><i>act</i> (QAction)</dt> |
|
150 <dd> |
|
151 reference to the triggering action |
|
152 </dd> |
|
153 </dl><a NAME="BookmarksToolBar.__newBookmark" ID="BookmarksToolBar.__newBookmark"></a> |
|
154 <h4>BookmarksToolBar.__newBookmark</h4> |
|
155 <b>__newBookmark</b>(<i></i>) |
|
156 <p> |
|
157 Private slot to add a new bookmark. |
|
158 </p><a NAME="BookmarksToolBar.__newFolder" ID="BookmarksToolBar.__newFolder"></a> |
|
159 <h4>BookmarksToolBar.__newFolder</h4> |
|
160 <b>__newFolder</b>(<i></i>) |
|
161 <p> |
|
162 Private slot to add a new bookmarks folder. |
|
163 </p><a NAME="BookmarksToolBar.__openBookmark" ID="BookmarksToolBar.__openBookmark"></a> |
|
164 <h4>BookmarksToolBar.__openBookmark</h4> |
|
165 <b>__openBookmark</b>(<i>act</i>) |
|
166 <p> |
|
167 Private slot to open a bookmark in the current browser tab. |
|
168 </p><dl> |
|
169 <dt><i>act</i> (QAction)</dt> |
|
170 <dd> |
|
171 reference to the triggering action |
|
172 </dd> |
|
173 </dl><a NAME="BookmarksToolBar.__openBookmarkInNewTab" ID="BookmarksToolBar.__openBookmarkInNewTab"></a> |
|
174 <h4>BookmarksToolBar.__openBookmarkInNewTab</h4> |
|
175 <b>__openBookmarkInNewTab</b>(<i>act</i>) |
|
176 <p> |
|
177 Private slot to open a bookmark in a new browser tab. |
|
178 </p><dl> |
|
179 <dt><i>act</i> (QAction)</dt> |
|
180 <dd> |
|
181 reference to the triggering action |
|
182 </dd> |
|
183 </dl><a NAME="BookmarksToolBar.__rebuild" ID="BookmarksToolBar.__rebuild"></a> |
|
184 <h4>BookmarksToolBar.__rebuild</h4> |
|
185 <b>__rebuild</b>(<i></i>) |
|
186 <p> |
|
187 Private slot to rebuild the toolbar. |
|
188 </p><a NAME="BookmarksToolBar.__removeBookmark" ID="BookmarksToolBar.__removeBookmark"></a> |
|
189 <h4>BookmarksToolBar.__removeBookmark</h4> |
|
190 <b>__removeBookmark</b>(<i>act</i>) |
|
191 <p> |
|
192 Private slot to remove a bookmark. |
|
193 </p><dl> |
|
194 <dt><i>act</i> (QAction)</dt> |
|
195 <dd> |
|
196 reference to the triggering action |
|
197 </dd> |
|
198 </dl><a NAME="BookmarksToolBar._createMenu" ID="BookmarksToolBar._createMenu"></a> |
|
199 <h4>BookmarksToolBar._createMenu</h4> |
|
200 <b>_createMenu</b>(<i></i>) |
|
201 <p> |
|
202 Protected method to create the menu for a tool bar action. |
|
203 </p><dl> |
|
204 <dt>Returns:</dt> |
|
205 <dd> |
|
206 menu for a tool bar action (E5ModelMenu) |
|
207 </dd> |
|
208 </dl> |
|
209 <div align="right"><a href="#top">Up</a></div> |
|
210 <hr /> |
|
211 </body></html> |