Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.SpeedDial.PageThumbnailer.html
eric6/Documentation/Source/eric6.WebBrowser.SpeedDial.PageThumbnailer.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.SpeedDial.PageThumbnailer</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.WebBrowser.SpeedDial.PageThumbnailer</h1> | |
| 23 <p> | |
| 24 Module implementing an object to create a thumbnail image of a web site. | |
| 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="#PageThumbnailer">PageThumbnailer</a></td> | |
| 34 <td>Class implementing a thumbnail creator for web sites.</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="PageThumbnailer" ID="PageThumbnailer"></a> | |
| 43 <h2>PageThumbnailer</h2> | |
| 44 <p> | |
| 45 Class implementing a thumbnail creator for web sites. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>thumbnailCreated(QPixmap)</dt> | |
| 49 <dd> | |
| 50 emitted after the thumbnail has been | |
| 51 created | |
| 52 </dd> | |
| 53 </dl> | |
| 54 <h3>Derived from</h3> | |
| 55 QObject | |
| 56 <h3>Class Attributes</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Class Methods</h3> | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Methods</h3> | |
| 65 <table> | |
| 66 <tr> | |
| 67 <td><a href="#PageThumbnailer.__init__">PageThumbnailer</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#PageThumbnailer.__createThumbnail">__createThumbnail</a></td> | |
| 71 <td>Private slot creating the thumbnail of the web site.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#PageThumbnailer.__grabThumbnail">__grabThumbnail</a></td> | |
| 74 <td>Private slot to grab the thumbnail image from the view.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#PageThumbnailer.loadTitle">loadTitle</a></td> | |
| 77 <td>Public method to check, if the title is loaded from the web site.</td> | |
| 78 </tr><tr> | |
| 79 <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> | |
| 81 </tr><tr> | |
| 82 <td><a href="#PageThumbnailer.setSize">setSize</a></td> | |
| 83 <td>Public method to set the size of the image.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#PageThumbnailer.setUrl">setUrl</a></td> | |
| 86 <td>Public method to set the URL of the site to be thumbnailed.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#PageThumbnailer.start">start</a></td> | |
| 89 <td>Public method to start the thumbnailing action.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#PageThumbnailer.title">title</a></td> | |
| 92 <td>Public method to get the title of the thumbnail.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#PageThumbnailer.url">url</a></td> | |
| 95 <td>Public method to get the URL of the thumbnail.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 <table> | |
| 100 <tr><td>None</td></tr> | |
| 101 </table> | |
| 102 <a NAME="PageThumbnailer.__init__" ID="PageThumbnailer.__init__"></a> | |
| 103 <h4>PageThumbnailer (Constructor)</h4> | |
| 104 <b>PageThumbnailer</b>(<i>parent=None</i>) | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p><dl> | |
| 108 <dt><i>parent</i></dt> | |
| 109 <dd> | |
| 110 reference to the parent object (QObject) | |
| 111 </dd> | |
| 112 </dl><a NAME="PageThumbnailer.__createThumbnail" ID="PageThumbnailer.__createThumbnail"></a> | |
| 113 <h4>PageThumbnailer.__createThumbnail</h4> | |
| 114 <b>__createThumbnail</b>(<i>status</i>) | |
| 115 <p> | |
| 116 Private slot creating the thumbnail of the web site. | |
| 117 </p><dl> | |
| 118 <dt><i>status</i></dt> | |
| 119 <dd> | |
| 120 flag indicating a successful load of the web site | |
| 121 (boolean) | |
| 122 </dd> | |
| 123 </dl><a NAME="PageThumbnailer.__grabThumbnail" ID="PageThumbnailer.__grabThumbnail"></a> | |
| 124 <h4>PageThumbnailer.__grabThumbnail</h4> | |
| 125 <b>__grabThumbnail</b>(<i></i>) | |
| 126 <p> | |
| 127 Private slot to grab the thumbnail image from the view. | |
| 128 </p><a NAME="PageThumbnailer.loadTitle" ID="PageThumbnailer.loadTitle"></a> | |
| 129 <h4>PageThumbnailer.loadTitle</h4> | |
| 130 <b>loadTitle</b>(<i></i>) | |
| 131 <p> | |
| 132 Public method to check, if the title is loaded from the web site. | |
| 133 </p><dl> | |
| 134 <dt>Returns:</dt> | |
| 135 <dd> | |
| 136 flag indicating, that the title is loaded (boolean) | |
| 137 </dd> | |
| 138 </dl><a NAME="PageThumbnailer.setLoadTitle" ID="PageThumbnailer.setLoadTitle"></a> | |
| 139 <h4>PageThumbnailer.setLoadTitle</h4> | |
| 140 <b>setLoadTitle</b>(<i>load</i>) | |
| 141 <p> | |
| 142 Public method to set a flag indicating to load the title from | |
| 143 the web site. | |
| 144 </p><dl> | |
| 145 <dt><i>load</i></dt> | |
| 146 <dd> | |
| 147 flag indicating to load the title (boolean) | |
| 148 </dd> | |
| 149 </dl><a NAME="PageThumbnailer.setSize" ID="PageThumbnailer.setSize"></a> | |
| 150 <h4>PageThumbnailer.setSize</h4> | |
| 151 <b>setSize</b>(<i>size</i>) | |
| 152 <p> | |
| 153 Public method to set the size of the image. | |
| 154 </p><dl> | |
| 155 <dt><i>size</i></dt> | |
| 156 <dd> | |
| 157 size of the image (QSize) | |
| 158 </dd> | |
| 159 </dl><a NAME="PageThumbnailer.setUrl" ID="PageThumbnailer.setUrl"></a> | |
| 160 <h4>PageThumbnailer.setUrl</h4> | |
| 161 <b>setUrl</b>(<i>url</i>) | |
| 162 <p> | |
| 163 Public method to set the URL of the site to be thumbnailed. | |
| 164 </p><dl> | |
| 165 <dt><i>url</i></dt> | |
| 166 <dd> | |
| 167 URL of the web site (QUrl) | |
| 168 </dd> | |
| 169 </dl><a NAME="PageThumbnailer.start" ID="PageThumbnailer.start"></a> | |
| 170 <h4>PageThumbnailer.start</h4> | |
| 171 <b>start</b>(<i></i>) | |
| 172 <p> | |
| 173 Public method to start the thumbnailing action. | |
| 174 </p><a NAME="PageThumbnailer.title" ID="PageThumbnailer.title"></a> | |
| 175 <h4>PageThumbnailer.title</h4> | |
| 176 <b>title</b>(<i></i>) | |
| 177 <p> | |
| 178 Public method to get the title of the thumbnail. | |
| 179 </p><dl> | |
| 180 <dt>Returns:</dt> | |
| 181 <dd> | |
| 182 title of the thumbnail (string) | |
| 183 </dd> | |
| 184 </dl><a NAME="PageThumbnailer.url" ID="PageThumbnailer.url"></a> | |
| 185 <h4>PageThumbnailer.url</h4> | |
| 186 <b>url</b>(<i></i>) | |
| 187 <p> | |
| 188 Public method to get the URL of the thumbnail. | |
| 189 </p><dl> | |
| 190 <dt>Returns:</dt> | |
| 191 <dd> | |
| 192 URL of the thumbnail (QUrl) | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <div align="right"><a href="#top">Up</a></div> | |
| 196 <hr /> | |
| 197 </body></html> |
