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