Documentation/Source/eric5.Helpviewer.SpeedDial.PageThumbnailer.html

changeset 1670
6fd889391d2c
child 2367
78f6c8193d37
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.SpeedDial.PageThumbnailer.html	Sat Feb 25 17:54:39 2012 +0100
@@ -0,0 +1,188 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.SpeedDial.PageThumbnailer</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.SpeedDial.PageThumbnailer</h1>
+<p>
+Module implementing an object to create a thumbnail image of a web site.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PageThumbnailer">PageThumbnailer</a></td>
+<td>Class implementing a thumbnail creator for web sites.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PageThumbnailer" ID="PageThumbnailer"></a>
+<h2>PageThumbnailer</h2>
+<p>
+    Class implementing a thumbnail creator for web sites.
+</p><h3>Signals</h3>
+<dl>
+<dt>thumbnailCreated(QPixmap)</dt>
+<dd>
+emitted after the thumbnail has been created
+</dd>
+</dl>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PageThumbnailer.__init__">PageThumbnailer</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.__createThumbnail">__createThumbnail</a></td>
+<td>Private slot creating the thumbnail of the web site.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.loadTitle">loadTitle</a></td>
+<td>Public method to check, if the title is loaded from the web site.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.setLoadTitle">setLoadTitle</a></td>
+<td>Public method to set a flag indicating to load the title from the web site.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.setSize">setSize</a></td>
+<td>Public method to set the size of the image.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.setUrl">setUrl</a></td>
+<td>Public method to set the URL of the site to be thumbnailed.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.start">start</a></td>
+<td>Public method to start the thumbnailing action.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.title">title</a></td>
+<td>Public method to get the title of the thumbnail.</td>
+</tr><tr>
+<td><a href="#PageThumbnailer.url">url</a></td>
+<td>Public method to get the URL of the thumbnail.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="PageThumbnailer.__init__" ID="PageThumbnailer.__init__"></a>
+<h4>PageThumbnailer (Constructor)</h4>
+<b>PageThumbnailer</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="PageThumbnailer.__createThumbnail" ID="PageThumbnailer.__createThumbnail"></a>
+<h4>PageThumbnailer.__createThumbnail</h4>
+<b>__createThumbnail</b>(<i>status</i>)
+<p>
+        Private slot creating the thumbnail of the web site.
+</p><dl>
+<dt><i>status</i></dt>
+<dd>
+flag indicating a successful load of the web site (boolean)
+</dd>
+</dl><a NAME="PageThumbnailer.loadTitle" ID="PageThumbnailer.loadTitle"></a>
+<h4>PageThumbnailer.loadTitle</h4>
+<b>loadTitle</b>(<i></i>)
+<p>
+        Public method to check, if the title is loaded from the web site.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating, that the title is loaded (boolean)
+</dd>
+</dl><a NAME="PageThumbnailer.setLoadTitle" ID="PageThumbnailer.setLoadTitle"></a>
+<h4>PageThumbnailer.setLoadTitle</h4>
+<b>setLoadTitle</b>(<i>load</i>)
+<p>
+        Public method to set a flag indicating to load the title from
+        the web site.
+</p><dl>
+<dt><i>load</i></dt>
+<dd>
+flag indicating to load the title (boolean)
+</dd>
+</dl><a NAME="PageThumbnailer.setSize" ID="PageThumbnailer.setSize"></a>
+<h4>PageThumbnailer.setSize</h4>
+<b>setSize</b>(<i>size</i>)
+<p>
+        Public method to set the size of the image.
+</p><dl>
+<dt><i>size</i></dt>
+<dd>
+size of the image (QSize)
+</dd>
+</dl><a NAME="PageThumbnailer.setUrl" ID="PageThumbnailer.setUrl"></a>
+<h4>PageThumbnailer.setUrl</h4>
+<b>setUrl</b>(<i>url</i>)
+<p>
+        Public method to set the URL of the site to be thumbnailed.
+</p><dl>
+<dt><i>url</i></dt>
+<dd>
+URL of the web site (QUrl)
+</dd>
+</dl><a NAME="PageThumbnailer.start" ID="PageThumbnailer.start"></a>
+<h4>PageThumbnailer.start</h4>
+<b>start</b>(<i></i>)
+<p>
+        Public method to start the thumbnailing action.
+</p><a NAME="PageThumbnailer.title" ID="PageThumbnailer.title"></a>
+<h4>PageThumbnailer.title</h4>
+<b>title</b>(<i></i>)
+<p>
+        Public method to get the title of the thumbnail.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+title of the thumbnail (string)
+</dd>
+</dl><a NAME="PageThumbnailer.url" ID="PageThumbnailer.url"></a>
+<h4>PageThumbnailer.url</h4>
+<b>url</b>(<i></i>)
+<p>
+        Public method to get the URL of the thumbnail.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+URL of the thumbnail (QUrl)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial