16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.WebBrowser.SpeedDial.PageThumbnailer</h1> |
23 <h1>eric6.WebBrowser.SpeedDial.PageThumbnailer</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing an object to create a thumbnail image of a web site. |
26 Module implementing an object to create a thumbnail image of a web site. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#PageThumbnailer">PageThumbnailer</a></td> |
38 <td><a href="#PageThumbnailer">PageThumbnailer</a></td> |
34 <td>Class implementing a thumbnail creator for web sites.</td> |
39 <td>Class implementing a thumbnail creator for web sites.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
38 <table> |
43 |
39 <tr><td>None</td></tr> |
44 <table> |
40 </table> |
45 <tr><td>None</td></tr> |
41 <hr /><hr /> |
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
42 <a NAME="PageThumbnailer" ID="PageThumbnailer"></a> |
49 <a NAME="PageThumbnailer" ID="PageThumbnailer"></a> |
43 <h2>PageThumbnailer</h2> |
50 <h2>PageThumbnailer</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a thumbnail creator for web sites. |
53 Class implementing a thumbnail creator for web sites. |
46 </p><h3>Signals</h3> |
54 </p> |
47 <dl> |
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
48 <dt>thumbnailCreated(QPixmap)</dt> |
58 <dt>thumbnailCreated(QPixmap)</dt> |
49 <dd> |
59 <dd> |
50 emitted after the thumbnail has been |
60 emitted after the thumbnail has been |
51 created |
61 created |
52 </dd> |
62 </dd> |
53 </dl> |
63 </dl> |
54 <h3>Derived from</h3> |
64 <h3>Derived from</h3> |
55 QObject |
65 QObject |
56 <h3>Class Attributes</h3> |
66 <h3>Class Attributes</h3> |
|
67 |
57 <table> |
68 <table> |
58 <tr><td>None</td></tr> |
69 <tr><td>None</td></tr> |
59 </table> |
70 </table> |
60 <h3>Class Methods</h3> |
71 <h3>Class Methods</h3> |
|
72 |
61 <table> |
73 <table> |
62 <tr><td>None</td></tr> |
74 <tr><td>None</td></tr> |
63 </table> |
75 </table> |
64 <h3>Methods</h3> |
76 <h3>Methods</h3> |
65 <table> |
77 |
|
78 <table> |
|
79 |
66 <tr> |
80 <tr> |
67 <td><a href="#PageThumbnailer.__init__">PageThumbnailer</a></td> |
81 <td><a href="#PageThumbnailer.__init__">PageThumbnailer</a></td> |
68 <td>Constructor</td> |
82 <td>Constructor</td> |
69 </tr><tr> |
83 </tr> |
|
84 <tr> |
70 <td><a href="#PageThumbnailer.__createThumbnail">__createThumbnail</a></td> |
85 <td><a href="#PageThumbnailer.__createThumbnail">__createThumbnail</a></td> |
71 <td>Private slot creating the thumbnail of the web site.</td> |
86 <td>Private slot creating the thumbnail of the web site.</td> |
72 </tr><tr> |
87 </tr> |
|
88 <tr> |
73 <td><a href="#PageThumbnailer.__grabThumbnail">__grabThumbnail</a></td> |
89 <td><a href="#PageThumbnailer.__grabThumbnail">__grabThumbnail</a></td> |
74 <td>Private slot to grab the thumbnail image from the view.</td> |
90 <td>Private slot to grab the thumbnail image from the view.</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#PageThumbnailer.loadTitle">loadTitle</a></td> |
93 <td><a href="#PageThumbnailer.loadTitle">loadTitle</a></td> |
77 <td>Public method to check, if the title is loaded from the web site.</td> |
94 <td>Public method to check, if the title is loaded from the web site.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#PageThumbnailer.setLoadTitle">setLoadTitle</a></td> |
97 <td><a href="#PageThumbnailer.setLoadTitle">setLoadTitle</a></td> |
80 <td>Public method to set a flag indicating to load the title from the web site.</td> |
98 <td>Public method to set a flag indicating to load the title from the web site.</td> |
81 </tr><tr> |
99 </tr> |
|
100 <tr> |
82 <td><a href="#PageThumbnailer.setSize">setSize</a></td> |
101 <td><a href="#PageThumbnailer.setSize">setSize</a></td> |
83 <td>Public method to set the size of the image.</td> |
102 <td>Public method to set the size of the image.</td> |
84 </tr><tr> |
103 </tr> |
|
104 <tr> |
85 <td><a href="#PageThumbnailer.setUrl">setUrl</a></td> |
105 <td><a href="#PageThumbnailer.setUrl">setUrl</a></td> |
86 <td>Public method to set the URL of the site to be thumbnailed.</td> |
106 <td>Public method to set the URL of the site to be thumbnailed.</td> |
87 </tr><tr> |
107 </tr> |
|
108 <tr> |
88 <td><a href="#PageThumbnailer.start">start</a></td> |
109 <td><a href="#PageThumbnailer.start">start</a></td> |
89 <td>Public method to start the thumbnailing action.</td> |
110 <td>Public method to start the thumbnailing action.</td> |
90 </tr><tr> |
111 </tr> |
|
112 <tr> |
91 <td><a href="#PageThumbnailer.title">title</a></td> |
113 <td><a href="#PageThumbnailer.title">title</a></td> |
92 <td>Public method to get the title of the thumbnail.</td> |
114 <td>Public method to get the title of the thumbnail.</td> |
93 </tr><tr> |
115 </tr> |
|
116 <tr> |
94 <td><a href="#PageThumbnailer.url">url</a></td> |
117 <td><a href="#PageThumbnailer.url">url</a></td> |
95 <td>Public method to get the URL of the thumbnail.</td> |
118 <td>Public method to get the URL of the thumbnail.</td> |
96 </tr> |
119 </tr> |
97 </table> |
120 </table> |
98 <h3>Static Methods</h3> |
121 <h3>Static Methods</h3> |
99 <table> |
122 |
100 <tr><td>None</td></tr> |
123 <table> |
101 </table> |
124 <tr><td>None</td></tr> |
|
125 </table> |
|
126 |
102 <a NAME="PageThumbnailer.__init__" ID="PageThumbnailer.__init__"></a> |
127 <a NAME="PageThumbnailer.__init__" ID="PageThumbnailer.__init__"></a> |
103 <h4>PageThumbnailer (Constructor)</h4> |
128 <h4>PageThumbnailer (Constructor)</h4> |
104 <b>PageThumbnailer</b>(<i>parent=None</i>) |
129 <b>PageThumbnailer</b>(<i>parent=None</i>) |
|
130 |
105 <p> |
131 <p> |
106 Constructor |
132 Constructor |
107 </p><dl> |
133 </p> |
|
134 <dl> |
|
135 |
108 <dt><i>parent</i></dt> |
136 <dt><i>parent</i></dt> |
109 <dd> |
137 <dd> |
110 reference to the parent object (QObject) |
138 reference to the parent object (QObject) |
111 </dd> |
139 </dd> |
112 </dl><a NAME="PageThumbnailer.__createThumbnail" ID="PageThumbnailer.__createThumbnail"></a> |
140 </dl> |
|
141 <a NAME="PageThumbnailer.__createThumbnail" ID="PageThumbnailer.__createThumbnail"></a> |
113 <h4>PageThumbnailer.__createThumbnail</h4> |
142 <h4>PageThumbnailer.__createThumbnail</h4> |
114 <b>__createThumbnail</b>(<i>status</i>) |
143 <b>__createThumbnail</b>(<i>status</i>) |
|
144 |
115 <p> |
145 <p> |
116 Private slot creating the thumbnail of the web site. |
146 Private slot creating the thumbnail of the web site. |
117 </p><dl> |
147 </p> |
|
148 <dl> |
|
149 |
118 <dt><i>status</i></dt> |
150 <dt><i>status</i></dt> |
119 <dd> |
151 <dd> |
120 flag indicating a successful load of the web site |
152 flag indicating a successful load of the web site |
121 (boolean) |
153 (boolean) |
122 </dd> |
154 </dd> |
123 </dl><a NAME="PageThumbnailer.__grabThumbnail" ID="PageThumbnailer.__grabThumbnail"></a> |
155 </dl> |
|
156 <a NAME="PageThumbnailer.__grabThumbnail" ID="PageThumbnailer.__grabThumbnail"></a> |
124 <h4>PageThumbnailer.__grabThumbnail</h4> |
157 <h4>PageThumbnailer.__grabThumbnail</h4> |
125 <b>__grabThumbnail</b>(<i></i>) |
158 <b>__grabThumbnail</b>(<i></i>) |
|
159 |
126 <p> |
160 <p> |
127 Private slot to grab the thumbnail image from the view. |
161 Private slot to grab the thumbnail image from the view. |
128 </p><a NAME="PageThumbnailer.loadTitle" ID="PageThumbnailer.loadTitle"></a> |
162 </p> |
|
163 <a NAME="PageThumbnailer.loadTitle" ID="PageThumbnailer.loadTitle"></a> |
129 <h4>PageThumbnailer.loadTitle</h4> |
164 <h4>PageThumbnailer.loadTitle</h4> |
130 <b>loadTitle</b>(<i></i>) |
165 <b>loadTitle</b>(<i></i>) |
|
166 |
131 <p> |
167 <p> |
132 Public method to check, if the title is loaded from the web site. |
168 Public method to check, if the title is loaded from the web site. |
133 </p><dl> |
169 </p> |
|
170 <dl> |
134 <dt>Returns:</dt> |
171 <dt>Returns:</dt> |
135 <dd> |
172 <dd> |
136 flag indicating, that the title is loaded (boolean) |
173 flag indicating, that the title is loaded (boolean) |
137 </dd> |
174 </dd> |
138 </dl><a NAME="PageThumbnailer.setLoadTitle" ID="PageThumbnailer.setLoadTitle"></a> |
175 </dl> |
|
176 <a NAME="PageThumbnailer.setLoadTitle" ID="PageThumbnailer.setLoadTitle"></a> |
139 <h4>PageThumbnailer.setLoadTitle</h4> |
177 <h4>PageThumbnailer.setLoadTitle</h4> |
140 <b>setLoadTitle</b>(<i>load</i>) |
178 <b>setLoadTitle</b>(<i>load</i>) |
|
179 |
141 <p> |
180 <p> |
142 Public method to set a flag indicating to load the title from |
181 Public method to set a flag indicating to load the title from |
143 the web site. |
182 the web site. |
144 </p><dl> |
183 </p> |
|
184 <dl> |
|
185 |
145 <dt><i>load</i></dt> |
186 <dt><i>load</i></dt> |
146 <dd> |
187 <dd> |
147 flag indicating to load the title (boolean) |
188 flag indicating to load the title (boolean) |
148 </dd> |
189 </dd> |
149 </dl><a NAME="PageThumbnailer.setSize" ID="PageThumbnailer.setSize"></a> |
190 </dl> |
|
191 <a NAME="PageThumbnailer.setSize" ID="PageThumbnailer.setSize"></a> |
150 <h4>PageThumbnailer.setSize</h4> |
192 <h4>PageThumbnailer.setSize</h4> |
151 <b>setSize</b>(<i>size</i>) |
193 <b>setSize</b>(<i>size</i>) |
|
194 |
152 <p> |
195 <p> |
153 Public method to set the size of the image. |
196 Public method to set the size of the image. |
154 </p><dl> |
197 </p> |
|
198 <dl> |
|
199 |
155 <dt><i>size</i></dt> |
200 <dt><i>size</i></dt> |
156 <dd> |
201 <dd> |
157 size of the image (QSize) |
202 size of the image (QSize) |
158 </dd> |
203 </dd> |
159 </dl><a NAME="PageThumbnailer.setUrl" ID="PageThumbnailer.setUrl"></a> |
204 </dl> |
|
205 <a NAME="PageThumbnailer.setUrl" ID="PageThumbnailer.setUrl"></a> |
160 <h4>PageThumbnailer.setUrl</h4> |
206 <h4>PageThumbnailer.setUrl</h4> |
161 <b>setUrl</b>(<i>url</i>) |
207 <b>setUrl</b>(<i>url</i>) |
|
208 |
162 <p> |
209 <p> |
163 Public method to set the URL of the site to be thumbnailed. |
210 Public method to set the URL of the site to be thumbnailed. |
164 </p><dl> |
211 </p> |
|
212 <dl> |
|
213 |
165 <dt><i>url</i></dt> |
214 <dt><i>url</i></dt> |
166 <dd> |
215 <dd> |
167 URL of the web site (QUrl) |
216 URL of the web site (QUrl) |
168 </dd> |
217 </dd> |
169 </dl><a NAME="PageThumbnailer.start" ID="PageThumbnailer.start"></a> |
218 </dl> |
|
219 <a NAME="PageThumbnailer.start" ID="PageThumbnailer.start"></a> |
170 <h4>PageThumbnailer.start</h4> |
220 <h4>PageThumbnailer.start</h4> |
171 <b>start</b>(<i></i>) |
221 <b>start</b>(<i></i>) |
|
222 |
172 <p> |
223 <p> |
173 Public method to start the thumbnailing action. |
224 Public method to start the thumbnailing action. |
174 </p><a NAME="PageThumbnailer.title" ID="PageThumbnailer.title"></a> |
225 </p> |
|
226 <a NAME="PageThumbnailer.title" ID="PageThumbnailer.title"></a> |
175 <h4>PageThumbnailer.title</h4> |
227 <h4>PageThumbnailer.title</h4> |
176 <b>title</b>(<i></i>) |
228 <b>title</b>(<i></i>) |
|
229 |
177 <p> |
230 <p> |
178 Public method to get the title of the thumbnail. |
231 Public method to get the title of the thumbnail. |
179 </p><dl> |
232 </p> |
|
233 <dl> |
180 <dt>Returns:</dt> |
234 <dt>Returns:</dt> |
181 <dd> |
235 <dd> |
182 title of the thumbnail (string) |
236 title of the thumbnail (string) |
183 </dd> |
237 </dd> |
184 </dl><a NAME="PageThumbnailer.url" ID="PageThumbnailer.url"></a> |
238 </dl> |
|
239 <a NAME="PageThumbnailer.url" ID="PageThumbnailer.url"></a> |
185 <h4>PageThumbnailer.url</h4> |
240 <h4>PageThumbnailer.url</h4> |
186 <b>url</b>(<i></i>) |
241 <b>url</b>(<i></i>) |
|
242 |
187 <p> |
243 <p> |
188 Public method to get the URL of the thumbnail. |
244 Public method to get the URL of the thumbnail. |
189 </p><dl> |
245 </p> |
|
246 <dl> |
190 <dt>Returns:</dt> |
247 <dt>Returns:</dt> |
191 <dd> |
248 <dd> |
192 URL of the thumbnail (QUrl) |
249 URL of the thumbnail (QUrl) |
193 </dd> |
250 </dd> |
194 </dl> |
251 </dl> |