--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.E4Gui.E4SqueezeLabels.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,195 @@ +<?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.E4Gui.E4SqueezeLabels</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.E4Gui.E4SqueezeLabels</h1> +<p> +Module implementing labels that squeeze their contents to fit the size of the label. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#E4SqueezeLabel">E4SqueezeLabel</a></td> +<td>Class implementing a label that squeezes its contents to fit it's size.</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath">E4SqueezeLabelPath</a></td> +<td>Class implementing a label showing a file path compacted to fit it's size.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="E4SqueezeLabel" ID="E4SqueezeLabel"></a> +<h2>E4SqueezeLabel</h2> +<p> + Class implementing a label that squeezes its contents to fit it's size. +</p> +<h3>Derived from</h3> +QLabel +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#E4SqueezeLabel.__init__">E4SqueezeLabel</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#E4SqueezeLabel.paintEvent">paintEvent</a></td> +<td>Protected method called when some painting is required.</td> +</tr><tr> +<td><a href="#E4SqueezeLabel.setText">setText</a></td> +<td>Public method to set the label's text.</td> +</tr> +</table> +<a NAME="E4SqueezeLabel.__init__" ID="E4SqueezeLabel.__init__"></a> +<h4>E4SqueezeLabel (Constructor)</h4> +<b>E4SqueezeLabel</b>(<i>parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent Widget (QWidget) +</dd> +</dl><a NAME="E4SqueezeLabel.paintEvent" ID="E4SqueezeLabel.paintEvent"></a> +<h4>E4SqueezeLabel.paintEvent</h4> +<b>paintEvent</b>(<i>event</i>) +<p> + Protected method called when some painting is required. +</p><dl> +<dt><i>event</i></dt> +<dd> +reference to the paint event (QPaintEvent) +</dd> +</dl><a NAME="E4SqueezeLabel.setText" ID="E4SqueezeLabel.setText"></a> +<h4>E4SqueezeLabel.setText</h4> +<b>setText</b>(<i>txt</i>) +<p> + Public method to set the label's text. +</p><dl> +<dt><i>txt</i></dt> +<dd> +the text to be shown (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="E4SqueezeLabelPath" ID="E4SqueezeLabelPath"></a> +<h2>E4SqueezeLabelPath</h2> +<p> + Class implementing a label showing a file path compacted to fit it's size. +</p> +<h3>Derived from</h3> +QLabel +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#E4SqueezeLabelPath.__init__">E4SqueezeLabelPath</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath.length">length</a></td> +<td>Public method to return the length of a text in pixels.</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath.paintEvent">paintEvent</a></td> +<td>Protected method called when some painting is required.</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath.setPath">setPath</a></td> +<td>Public method to set the path of the label.</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath.setSurrounding">setSurrounding</a></td> +<td>Public method to set the surrounding of the path string.</td> +</tr><tr> +<td><a href="#E4SqueezeLabelPath.setTextPath">setTextPath</a></td> +<td>Public method to set the surrounding and the path of the label.</td> +</tr> +</table> +<a NAME="E4SqueezeLabelPath.__init__" ID="E4SqueezeLabelPath.__init__"></a> +<h4>E4SqueezeLabelPath (Constructor)</h4> +<b>E4SqueezeLabelPath</b>(<i>parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent Widget (QWidget) +</dd> +</dl><a NAME="E4SqueezeLabelPath.length" ID="E4SqueezeLabelPath.length"></a> +<h4>E4SqueezeLabelPath.length</h4> +<b>length</b>(<i>txt</i>) +<p> + Public method to return the length of a text in pixels. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to calculate the length for after wrapped (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +length of the wrapped text in pixels (integer) +</dd> +</dl><a NAME="E4SqueezeLabelPath.paintEvent" ID="E4SqueezeLabelPath.paintEvent"></a> +<h4>E4SqueezeLabelPath.paintEvent</h4> +<b>paintEvent</b>(<i>event</i>) +<p> + Protected method called when some painting is required. +</p><dl> +<dt><i>event</i></dt> +<dd> +reference to the paint event (QPaintEvent) +</dd> +</dl><a NAME="E4SqueezeLabelPath.setPath" ID="E4SqueezeLabelPath.setPath"></a> +<h4>E4SqueezeLabelPath.setPath</h4> +<b>setPath</b>(<i>path</i>) +<p> + Public method to set the path of the label. +</p><dl> +<dt><i>path</i></dt> +<dd> +path to be shown (string) +</dd> +</dl><a NAME="E4SqueezeLabelPath.setSurrounding" ID="E4SqueezeLabelPath.setSurrounding"></a> +<h4>E4SqueezeLabelPath.setSurrounding</h4> +<b>setSurrounding</b>(<i>surrounding</i>) +<p> + Public method to set the surrounding of the path string. +</p><dl> +<dt><i>surrounding</i></dt> +<dd> +the a string containg placeholders for the path (string) +</dd> +</dl><a NAME="E4SqueezeLabelPath.setTextPath" ID="E4SqueezeLabelPath.setTextPath"></a> +<h4>E4SqueezeLabelPath.setTextPath</h4> +<b>setTextPath</b>(<i>surrounding, path</i>) +<p> + Public method to set the surrounding and the path of the label. +</p><dl> +<dt><i>surrounding</i></dt> +<dd> +the a string containg placeholders for the path (string) +</dd><dt><i>path</i></dt> +<dd> +path to be shown (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file