|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Helpviewer.Bookmarks.BookmarksDialog</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.BookmarksDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to manage 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="#BookmarksDialog">BookmarksDialog</a></td> |
|
34 <td>Class implementing a dialog to manage 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="BookmarksDialog" ID="BookmarksDialog"></a> |
|
43 <h2>BookmarksDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog to manage 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 QDialog, Ui_BookmarksDialog |
|
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="#BookmarksDialog.__init__">BookmarksDialog</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#BookmarksDialog.__activated">__activated</a></td> |
|
73 <td>Private slot to handle the activation of an entry.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#BookmarksDialog.__customContextMenuRequested">__customContextMenuRequested</a></td> |
|
76 <td>Private slot to handle the context menu request for the bookmarks tree.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#BookmarksDialog.__edit">__edit</a></td> |
|
79 <td>Private slot to edit a bookmarks properties.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#BookmarksDialog.__editAddress">__editAddress</a></td> |
|
82 <td>Private slot to edit the address part of a bookmark.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#BookmarksDialog.__editName">__editName</a></td> |
|
85 <td>Private slot to edit the name part of a bookmark.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#BookmarksDialog.__expandNodes">__expandNodes</a></td> |
|
88 <td>Private method to expand all child nodes of a node.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#BookmarksDialog.__newFolder">__newFolder</a></td> |
|
91 <td>Private slot to add a new bookmarks folder.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#BookmarksDialog.__openBookmark">__openBookmark</a></td> |
|
94 <td>Private method to open a bookmark.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#BookmarksDialog.__openBookmarkInCurrentTab">__openBookmarkInCurrentTab</a></td> |
|
97 <td>Private slot to open a bookmark in the current browser tab.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#BookmarksDialog.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> |
|
100 <td>Private slot to open a bookmark in a new browser tab.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#BookmarksDialog.__saveExpandedNodes">__saveExpandedNodes</a></td> |
|
103 <td>Private method to save the child nodes of an expanded node.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#BookmarksDialog.__shutdown">__shutdown</a></td> |
|
106 <td>Private method to perform shutdown actions for the dialog.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#BookmarksDialog.closeEvent">closeEvent</a></td> |
|
109 <td>Protected method to handle the closing of the dialog.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#BookmarksDialog.reject">reject</a></td> |
|
112 <td>Public method called when the dialog is rejected.</td> |
|
113 </tr> |
|
114 </table> |
|
115 <h3>Static Methods</h3> |
|
116 <table> |
|
117 <tr><td>None</td></tr> |
|
118 </table> |
|
119 <a NAME="BookmarksDialog.__init__" ID="BookmarksDialog.__init__"></a> |
|
120 <h4>BookmarksDialog (Constructor)</h4> |
|
121 <b>BookmarksDialog</b>(<i>parent=None, manager=None</i>) |
|
122 <p> |
|
123 Constructor |
|
124 </p><dl> |
|
125 <dt><i>parent</i></dt> |
|
126 <dd> |
|
127 reference to the parent widget (QWidget |
|
128 </dd><dt><i>manager</i></dt> |
|
129 <dd> |
|
130 reference to the bookmarks manager object |
|
131 (BookmarksManager) |
|
132 </dd> |
|
133 </dl><a NAME="BookmarksDialog.__activated" ID="BookmarksDialog.__activated"></a> |
|
134 <h4>BookmarksDialog.__activated</h4> |
|
135 <b>__activated</b>(<i>idx</i>) |
|
136 <p> |
|
137 Private slot to handle the activation of an entry. |
|
138 </p><dl> |
|
139 <dt><i>idx</i></dt> |
|
140 <dd> |
|
141 reference to the entry index (QModelIndex) |
|
142 </dd> |
|
143 </dl><a NAME="BookmarksDialog.__customContextMenuRequested" ID="BookmarksDialog.__customContextMenuRequested"></a> |
|
144 <h4>BookmarksDialog.__customContextMenuRequested</h4> |
|
145 <b>__customContextMenuRequested</b>(<i>pos</i>) |
|
146 <p> |
|
147 Private slot to handle the context menu request for the bookmarks tree. |
|
148 </p><dl> |
|
149 <dt><i>pos</i></dt> |
|
150 <dd> |
|
151 position the context menu was requested (QPoint) |
|
152 </dd> |
|
153 </dl><a NAME="BookmarksDialog.__edit" ID="BookmarksDialog.__edit"></a> |
|
154 <h4>BookmarksDialog.__edit</h4> |
|
155 <b>__edit</b>(<i></i>) |
|
156 <p> |
|
157 Private slot to edit a bookmarks properties. |
|
158 </p><a NAME="BookmarksDialog.__editAddress" ID="BookmarksDialog.__editAddress"></a> |
|
159 <h4>BookmarksDialog.__editAddress</h4> |
|
160 <b>__editAddress</b>(<i></i>) |
|
161 <p> |
|
162 Private slot to edit the address part of a bookmark. |
|
163 </p><a NAME="BookmarksDialog.__editName" ID="BookmarksDialog.__editName"></a> |
|
164 <h4>BookmarksDialog.__editName</h4> |
|
165 <b>__editName</b>(<i></i>) |
|
166 <p> |
|
167 Private slot to edit the name part of a bookmark. |
|
168 </p><a NAME="BookmarksDialog.__expandNodes" ID="BookmarksDialog.__expandNodes"></a> |
|
169 <h4>BookmarksDialog.__expandNodes</h4> |
|
170 <b>__expandNodes</b>(<i>node</i>) |
|
171 <p> |
|
172 Private method to expand all child nodes of a node. |
|
173 </p><dl> |
|
174 <dt><i>node</i></dt> |
|
175 <dd> |
|
176 reference to the bookmark node to expand (BookmarkNode) |
|
177 </dd> |
|
178 </dl><a NAME="BookmarksDialog.__newFolder" ID="BookmarksDialog.__newFolder"></a> |
|
179 <h4>BookmarksDialog.__newFolder</h4> |
|
180 <b>__newFolder</b>(<i></i>) |
|
181 <p> |
|
182 Private slot to add a new bookmarks folder. |
|
183 </p><a NAME="BookmarksDialog.__openBookmark" ID="BookmarksDialog.__openBookmark"></a> |
|
184 <h4>BookmarksDialog.__openBookmark</h4> |
|
185 <b>__openBookmark</b>(<i>newTab</i>) |
|
186 <p> |
|
187 Private method to open a bookmark. |
|
188 </p><dl> |
|
189 <dt><i>newTab</i></dt> |
|
190 <dd> |
|
191 flag indicating to open the bookmark in a new tab |
|
192 (boolean) |
|
193 </dd> |
|
194 </dl><a NAME="BookmarksDialog.__openBookmarkInCurrentTab" ID="BookmarksDialog.__openBookmarkInCurrentTab"></a> |
|
195 <h4>BookmarksDialog.__openBookmarkInCurrentTab</h4> |
|
196 <b>__openBookmarkInCurrentTab</b>(<i></i>) |
|
197 <p> |
|
198 Private slot to open a bookmark in the current browser tab. |
|
199 </p><a NAME="BookmarksDialog.__openBookmarkInNewTab" ID="BookmarksDialog.__openBookmarkInNewTab"></a> |
|
200 <h4>BookmarksDialog.__openBookmarkInNewTab</h4> |
|
201 <b>__openBookmarkInNewTab</b>(<i></i>) |
|
202 <p> |
|
203 Private slot to open a bookmark in a new browser tab. |
|
204 </p><a NAME="BookmarksDialog.__saveExpandedNodes" ID="BookmarksDialog.__saveExpandedNodes"></a> |
|
205 <h4>BookmarksDialog.__saveExpandedNodes</h4> |
|
206 <b>__saveExpandedNodes</b>(<i>parent</i>) |
|
207 <p> |
|
208 Private method to save the child nodes of an expanded node. |
|
209 </p><dl> |
|
210 <dt><i>parent</i></dt> |
|
211 <dd> |
|
212 index of the parent node (QModelIndex) |
|
213 </dd> |
|
214 </dl><dl> |
|
215 <dt>Returns:</dt> |
|
216 <dd> |
|
217 flag indicating a change (boolean) |
|
218 </dd> |
|
219 </dl><a NAME="BookmarksDialog.__shutdown" ID="BookmarksDialog.__shutdown"></a> |
|
220 <h4>BookmarksDialog.__shutdown</h4> |
|
221 <b>__shutdown</b>(<i></i>) |
|
222 <p> |
|
223 Private method to perform shutdown actions for the dialog. |
|
224 </p><a NAME="BookmarksDialog.closeEvent" ID="BookmarksDialog.closeEvent"></a> |
|
225 <h4>BookmarksDialog.closeEvent</h4> |
|
226 <b>closeEvent</b>(<i>evt</i>) |
|
227 <p> |
|
228 Protected method to handle the closing of the dialog. |
|
229 </p><dl> |
|
230 <dt><i>evt</i></dt> |
|
231 <dd> |
|
232 reference to the event object (QCloseEvent) (ignored) |
|
233 </dd> |
|
234 </dl><a NAME="BookmarksDialog.reject" ID="BookmarksDialog.reject"></a> |
|
235 <h4>BookmarksDialog.reject</h4> |
|
236 <b>reject</b>(<i></i>) |
|
237 <p> |
|
238 Public method called when the dialog is rejected. |
|
239 </p> |
|
240 <div align="right"><a href="#top">Up</a></div> |
|
241 <hr /> |
|
242 </body></html> |