|
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.BookmarksDialog</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.BookmarksDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to manage bookmarks. |
|
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="#BookmarksDialog">BookmarksDialog</a></td> |
|
23 <td>Class implementing a dialog to manage bookmarks.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="BookmarksDialog" ID="BookmarksDialog"></a> |
|
32 <h2>BookmarksDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to manage bookmarks. |
|
35 </p><h4>Signals</h4> |
|
36 <dl> |
|
37 <dt>newUrl(const QUrl&, const QString&)</dt> |
|
38 <dd> |
|
39 emitted to open a URL in a new tab |
|
40 </dd><dt>openUrl(const QUrl&, const QString&)</dt> |
|
41 <dd> |
|
42 emitted to open a URL in the current |
|
43 tab |
|
44 </dd> |
|
45 </dl> |
|
46 <h3>Derived from</h3> |
|
47 QDialog, Ui_BookmarksDialog |
|
48 <h3>Class Attributes</h3> |
|
49 <table> |
|
50 <tr><td>None</td></tr> |
|
51 </table> |
|
52 <h3>Methods</h3> |
|
53 <table> |
|
54 <tr> |
|
55 <td><a href="#BookmarksDialog.__init__">BookmarksDialog</a></td> |
|
56 <td>Constructor</td> |
|
57 </tr><tr> |
|
58 <td><a href="#BookmarksDialog.__activated">__activated</a></td> |
|
59 <td>Private slot to handle the activation of an entry.</td> |
|
60 </tr><tr> |
|
61 <td><a href="#BookmarksDialog.__customContextMenuRequested">__customContextMenuRequested</a></td> |
|
62 <td>Private slot to handle the context menu request for the bookmarks tree.</td> |
|
63 </tr><tr> |
|
64 <td><a href="#BookmarksDialog.__editAddress">__editAddress</a></td> |
|
65 <td>Private slot to edit the address part of a bookmark.</td> |
|
66 </tr><tr> |
|
67 <td><a href="#BookmarksDialog.__editName">__editName</a></td> |
|
68 <td>Private slot to edit the name part of a bookmark.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#BookmarksDialog.__expandNodes">__expandNodes</a></td> |
|
71 <td>Private method to expand all child nodes of a node.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#BookmarksDialog.__newFolder">__newFolder</a></td> |
|
74 <td>Private slot to add a new bookmarks folder.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#BookmarksDialog.__openBookmark">__openBookmark</a></td> |
|
77 <td>Private method to open a bookmark.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#BookmarksDialog.__openBookmarkInCurrentTab">__openBookmarkInCurrentTab</a></td> |
|
80 <td>Private slot to open a bookmark in the current browser tab.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#BookmarksDialog.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> |
|
83 <td>Private slot to open a bookmark in a new browser tab.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#BookmarksDialog.__saveExpandedNodes">__saveExpandedNodes</a></td> |
|
86 <td>Private method to save the child nodes of an expanded node.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#BookmarksDialog.__shutdown">__shutdown</a></td> |
|
89 <td>Private method to perform shutdown actions for the dialog.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#BookmarksDialog.closeEvent">closeEvent</a></td> |
|
92 <td>Protected method to handle the closing of the dialog.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#BookmarksDialog.reject">reject</a></td> |
|
95 <td>Protected method called when the dialog is rejected.</td> |
|
96 </tr> |
|
97 </table> |
|
98 <a NAME="BookmarksDialog.__init__" ID="BookmarksDialog.__init__"></a> |
|
99 <h4>BookmarksDialog (Constructor)</h4> |
|
100 <b>BookmarksDialog</b>(<i>parent = None, manager = 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><dt><i>manager</i></dt> |
|
108 <dd> |
|
109 reference to the bookmarks manager object (BookmarksManager) |
|
110 </dd> |
|
111 </dl><a NAME="BookmarksDialog.__activated" ID="BookmarksDialog.__activated"></a> |
|
112 <h4>BookmarksDialog.__activated</h4> |
|
113 <b>__activated</b>(<i>idx</i>) |
|
114 <p> |
|
115 Private slot to handle the activation of an entry. |
|
116 </p><dl> |
|
117 <dt><i>idx</i></dt> |
|
118 <dd> |
|
119 reference to the entry index (QModelIndex) |
|
120 </dd> |
|
121 </dl><a NAME="BookmarksDialog.__customContextMenuRequested" ID="BookmarksDialog.__customContextMenuRequested"></a> |
|
122 <h4>BookmarksDialog.__customContextMenuRequested</h4> |
|
123 <b>__customContextMenuRequested</b>(<i>pos</i>) |
|
124 <p> |
|
125 Private slot to handle the context menu request for the bookmarks tree. |
|
126 </p><dl> |
|
127 <dt><i>pos</i></dt> |
|
128 <dd> |
|
129 position the context menu was requested (QPoint) |
|
130 </dd> |
|
131 </dl><a NAME="BookmarksDialog.__editAddress" ID="BookmarksDialog.__editAddress"></a> |
|
132 <h4>BookmarksDialog.__editAddress</h4> |
|
133 <b>__editAddress</b>(<i></i>) |
|
134 <p> |
|
135 Private slot to edit the address part of a bookmark. |
|
136 </p><a NAME="BookmarksDialog.__editName" ID="BookmarksDialog.__editName"></a> |
|
137 <h4>BookmarksDialog.__editName</h4> |
|
138 <b>__editName</b>(<i></i>) |
|
139 <p> |
|
140 Private slot to edit the name part of a bookmark. |
|
141 </p><a NAME="BookmarksDialog.__expandNodes" ID="BookmarksDialog.__expandNodes"></a> |
|
142 <h4>BookmarksDialog.__expandNodes</h4> |
|
143 <b>__expandNodes</b>(<i>node</i>) |
|
144 <p> |
|
145 Private method to expand all child nodes of a node. |
|
146 </p><dl> |
|
147 <dt><i>node</i></dt> |
|
148 <dd> |
|
149 reference to the bookmark node to expand (BookmarkNode) |
|
150 </dd> |
|
151 </dl><a NAME="BookmarksDialog.__newFolder" ID="BookmarksDialog.__newFolder"></a> |
|
152 <h4>BookmarksDialog.__newFolder</h4> |
|
153 <b>__newFolder</b>(<i></i>) |
|
154 <p> |
|
155 Private slot to add a new bookmarks folder. |
|
156 </p><a NAME="BookmarksDialog.__openBookmark" ID="BookmarksDialog.__openBookmark"></a> |
|
157 <h4>BookmarksDialog.__openBookmark</h4> |
|
158 <b>__openBookmark</b>(<i>newTab</i>) |
|
159 <p> |
|
160 Private method to open a bookmark. |
|
161 </p><dl> |
|
162 <dt><i>newTab</i></dt> |
|
163 <dd> |
|
164 flag indicating to open the bookmark in a new tab (boolean) |
|
165 </dd> |
|
166 </dl><a NAME="BookmarksDialog.__openBookmarkInCurrentTab" ID="BookmarksDialog.__openBookmarkInCurrentTab"></a> |
|
167 <h4>BookmarksDialog.__openBookmarkInCurrentTab</h4> |
|
168 <b>__openBookmarkInCurrentTab</b>(<i></i>) |
|
169 <p> |
|
170 Private slot to open a bookmark in the current browser tab. |
|
171 </p><a NAME="BookmarksDialog.__openBookmarkInNewTab" ID="BookmarksDialog.__openBookmarkInNewTab"></a> |
|
172 <h4>BookmarksDialog.__openBookmarkInNewTab</h4> |
|
173 <b>__openBookmarkInNewTab</b>(<i></i>) |
|
174 <p> |
|
175 Private slot to open a bookmark in a new browser tab. |
|
176 </p><a NAME="BookmarksDialog.__saveExpandedNodes" ID="BookmarksDialog.__saveExpandedNodes"></a> |
|
177 <h4>BookmarksDialog.__saveExpandedNodes</h4> |
|
178 <b>__saveExpandedNodes</b>(<i>parent</i>) |
|
179 <p> |
|
180 Private method to save the child nodes of an expanded node. |
|
181 </p><dl> |
|
182 <dt><i>parent</i></dt> |
|
183 <dd> |
|
184 index of the parent node (QModelIndex) |
|
185 </dd> |
|
186 </dl><dl> |
|
187 <dt>Returns:</dt> |
|
188 <dd> |
|
189 flag indicating a change (boolean) |
|
190 </dd> |
|
191 </dl><a NAME="BookmarksDialog.__shutdown" ID="BookmarksDialog.__shutdown"></a> |
|
192 <h4>BookmarksDialog.__shutdown</h4> |
|
193 <b>__shutdown</b>(<i></i>) |
|
194 <p> |
|
195 Private method to perform shutdown actions for the dialog. |
|
196 </p><a NAME="BookmarksDialog.closeEvent" ID="BookmarksDialog.closeEvent"></a> |
|
197 <h4>BookmarksDialog.closeEvent</h4> |
|
198 <b>closeEvent</b>(<i>evt</i>) |
|
199 <p> |
|
200 Protected method to handle the closing of the dialog. |
|
201 </p><dl> |
|
202 <dt><i>evt</i></dt> |
|
203 <dd> |
|
204 reference to the event object (QCloseEvent) (ignored) |
|
205 </dd> |
|
206 </dl><a NAME="BookmarksDialog.reject" ID="BookmarksDialog.reject"></a> |
|
207 <h4>BookmarksDialog.reject</h4> |
|
208 <b>reject</b>(<i></i>) |
|
209 <p> |
|
210 Protected method called when the dialog is rejected. |
|
211 </p> |
|
212 <div align="right"><a href="#top">Up</a></div> |
|
213 <hr /> |
|
214 </body></html> |