Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.SpeedDial.PageThumbnailer.html
Documentation/Source/eric5.Helpviewer.SpeedDial.PageThumbnailer.html
- changeset 1670
- 6fd889391d2c
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1667:02ad912c8645 | 1670:6fd889391d2c |
|---|---|
| 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.SpeedDial.PageThumbnailer</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.SpeedDial.PageThumbnailer</h1> | |
| 24 <p> | |
| 25 Module implementing an object to create a thumbnail image of a web site. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#PageThumbnailer">PageThumbnailer</a></td> | |
| 35 <td>Class implementing a thumbnail creator for web sites.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="PageThumbnailer" ID="PageThumbnailer"></a> | |
| 44 <h2>PageThumbnailer</h2> | |
| 45 <p> | |
| 46 Class implementing a thumbnail creator for web sites. | |
| 47 </p><h3>Signals</h3> | |
| 48 <dl> | |
| 49 <dt>thumbnailCreated(QPixmap)</dt> | |
| 50 <dd> | |
| 51 emitted after the thumbnail has been 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.loadTitle">loadTitle</a></td> | |
| 74 <td>Public method to check, if the title is loaded from the web site.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#PageThumbnailer.setLoadTitle">setLoadTitle</a></td> | |
| 77 <td>Public method to set a flag indicating to load the title from the web site.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#PageThumbnailer.setSize">setSize</a></td> | |
| 80 <td>Public method to set the size of the image.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#PageThumbnailer.setUrl">setUrl</a></td> | |
| 83 <td>Public method to set the URL of the site to be thumbnailed.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#PageThumbnailer.start">start</a></td> | |
| 86 <td>Public method to start the thumbnailing action.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#PageThumbnailer.title">title</a></td> | |
| 89 <td>Public method to get the title of the thumbnail.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#PageThumbnailer.url">url</a></td> | |
| 92 <td>Public method to get the URL of the thumbnail.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 <h3>Static Methods</h3> | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 <a NAME="PageThumbnailer.__init__" ID="PageThumbnailer.__init__"></a> | |
| 100 <h4>PageThumbnailer (Constructor)</h4> | |
| 101 <b>PageThumbnailer</b>(<i>parent=None</i>) | |
| 102 <p> | |
| 103 Constructor | |
| 104 </p><dl> | |
| 105 <dt><i>parent</i></dt> | |
| 106 <dd> | |
| 107 reference to the parent object (QObject) | |
| 108 </dd> | |
| 109 </dl><a NAME="PageThumbnailer.__createThumbnail" ID="PageThumbnailer.__createThumbnail"></a> | |
| 110 <h4>PageThumbnailer.__createThumbnail</h4> | |
| 111 <b>__createThumbnail</b>(<i>status</i>) | |
| 112 <p> | |
| 113 Private slot creating the thumbnail of the web site. | |
| 114 </p><dl> | |
| 115 <dt><i>status</i></dt> | |
| 116 <dd> | |
| 117 flag indicating a successful load of the web site (boolean) | |
| 118 </dd> | |
| 119 </dl><a NAME="PageThumbnailer.loadTitle" ID="PageThumbnailer.loadTitle"></a> | |
| 120 <h4>PageThumbnailer.loadTitle</h4> | |
| 121 <b>loadTitle</b>(<i></i>) | |
| 122 <p> | |
| 123 Public method to check, if the title is loaded from the web site. | |
| 124 </p><dl> | |
| 125 <dt>Returns:</dt> | |
| 126 <dd> | |
| 127 flag indicating, that the title is loaded (boolean) | |
| 128 </dd> | |
| 129 </dl><a NAME="PageThumbnailer.setLoadTitle" ID="PageThumbnailer.setLoadTitle"></a> | |
| 130 <h4>PageThumbnailer.setLoadTitle</h4> | |
| 131 <b>setLoadTitle</b>(<i>load</i>) | |
| 132 <p> | |
| 133 Public method to set a flag indicating to load the title from | |
| 134 the web site. | |
| 135 </p><dl> | |
| 136 <dt><i>load</i></dt> | |
| 137 <dd> | |
| 138 flag indicating to load the title (boolean) | |
| 139 </dd> | |
| 140 </dl><a NAME="PageThumbnailer.setSize" ID="PageThumbnailer.setSize"></a> | |
| 141 <h4>PageThumbnailer.setSize</h4> | |
| 142 <b>setSize</b>(<i>size</i>) | |
| 143 <p> | |
| 144 Public method to set the size of the image. | |
| 145 </p><dl> | |
| 146 <dt><i>size</i></dt> | |
| 147 <dd> | |
| 148 size of the image (QSize) | |
| 149 </dd> | |
| 150 </dl><a NAME="PageThumbnailer.setUrl" ID="PageThumbnailer.setUrl"></a> | |
| 151 <h4>PageThumbnailer.setUrl</h4> | |
| 152 <b>setUrl</b>(<i>url</i>) | |
| 153 <p> | |
| 154 Public method to set the URL of the site to be thumbnailed. | |
| 155 </p><dl> | |
| 156 <dt><i>url</i></dt> | |
| 157 <dd> | |
| 158 URL of the web site (QUrl) | |
| 159 </dd> | |
| 160 </dl><a NAME="PageThumbnailer.start" ID="PageThumbnailer.start"></a> | |
| 161 <h4>PageThumbnailer.start</h4> | |
| 162 <b>start</b>(<i></i>) | |
| 163 <p> | |
| 164 Public method to start the thumbnailing action. | |
| 165 </p><a NAME="PageThumbnailer.title" ID="PageThumbnailer.title"></a> | |
| 166 <h4>PageThumbnailer.title</h4> | |
| 167 <b>title</b>(<i></i>) | |
| 168 <p> | |
| 169 Public method to get the title of the thumbnail. | |
| 170 </p><dl> | |
| 171 <dt>Returns:</dt> | |
| 172 <dd> | |
| 173 title of the thumbnail (string) | |
| 174 </dd> | |
| 175 </dl><a NAME="PageThumbnailer.url" ID="PageThumbnailer.url"></a> | |
| 176 <h4>PageThumbnailer.url</h4> | |
| 177 <b>url</b>(<i></i>) | |
| 178 <p> | |
| 179 Public method to get the URL of the thumbnail. | |
| 180 </p><dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 URL of the thumbnail (QUrl) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <div align="right"><a href="#top">Up</a></div> | |
| 187 <hr /> | |
| 188 </body></html> |
