Documentation/Source/eric5.E5Gui.E5SqueezeLabels.html

changeset 58
37f0444c3479
parent 55
b5c84934de9c
child 409
0ea528e80202
--- a/Documentation/Source/eric5.E5Gui.E5SqueezeLabels.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5Gui.E5SqueezeLabels.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5Gui.E5SqueezeLabels</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#108;&#97;&#98;&#101;&#108;&#115; &#116;&#104;&#97;&#116; &#115;&#113;&#117;&#101;&#101;z&#101; &#116;&#104;&#101;&#105;&#114; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#102;&#105;&#116; &#116;&#104;&#101; &#115;&#105;z&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;.
+Module implementing labels that squeeze their contents to fit the size of the label.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,10 +32,10 @@
 <table>
 <tr>
 <td><a href="#E5SqueezeLabel">E5SqueezeLabel</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#108;&#97;&#98;&#101;&#108; &#116;&#104;&#97;&#116; &#115;&#113;&#117;&#101;&#101;z&#101;&#115; &#105;&#116;&#115; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#102;&#105;&#116; &#105;&#116;'&#115; &#115;&#105;z&#101;.</td>
+<td>Class implementing a label that squeezes its contents to fit it's size.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath">E5SqueezeLabelPath</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#108;&#97;&#98;&#101;&#108; &#115;&#104;&#111;w&#105;&#110;&#103; &#97; &#102;&#105;&#108;&#101; &#112;&#97;&#116;&#104; &#99;&#111;&#109;&#112;&#97;&#99;&#116;&#101;&#100; &#116;&#111; &#102;&#105;&#116; &#105;&#116;'&#115; &#115;&#105;z&#101;.</td>
+<td>Class implementing a label showing a file path compacted to fit it's size.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -46,7 +46,7 @@
 <a NAME="E5SqueezeLabel" ID="E5SqueezeLabel"></a>
 <h2>E5SqueezeLabel</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#108;&#97;&#98;&#101;&#108; &#116;&#104;&#97;&#116; &#115;&#113;&#117;&#101;&#101;z&#101;&#115; &#105;&#116;&#115; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#102;&#105;&#116; &#105;&#116;'&#115; &#115;&#105;z&#101;.
+    Class implementing a label that squeezes its contents to fit it's size.
 </p>
 <h3>Derived from</h3>
 QLabel
@@ -58,44 +58,44 @@
 <table>
 <tr>
 <td><a href="#E5SqueezeLabel.__init__">E5SqueezeLabel</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabel.paintEvent">paintEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#115;&#111;&#109;&#101; &#112;&#97;&#105;&#110;&#116;&#105;&#110;&#103; &#105;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100;.</td>
+<td>Protected method called when some painting is required.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabel.setText">setText</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;'&#115; &#116;&#101;x&#116;.</td>
+<td>Public method to set the label's text.</td>
 </tr>
 </table>
 <a NAME="E5SqueezeLabel.__init__" ID="E5SqueezeLabel.__init__"></a>
 <h4>E5SqueezeLabel (Constructor)</h4>
 <b>E5SqueezeLabel</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#87;&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent Widget (QWidget)
 </dd>
 </dl><a NAME="E5SqueezeLabel.paintEvent" ID="E5SqueezeLabel.paintEvent"></a>
 <h4>E5SqueezeLabel.paintEvent</h4>
 <b>paintEvent</b>(<i>event</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#115;&#111;&#109;&#101; &#112;&#97;&#105;&#110;&#116;&#105;&#110;&#103; &#105;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100;.
+        Protected method called when some painting is required.
 </p><dl>
 <dt><i>event</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#105;&#110;&#116; &#101;v&#101;&#110;&#116; (&#81;&#80;&#97;&#105;&#110;&#116;&#69;v&#101;&#110;&#116;)
+reference to the paint event (QPaintEvent)
 </dd>
 </dl><a NAME="E5SqueezeLabel.setText" ID="E5SqueezeLabel.setText"></a>
 <h4>E5SqueezeLabel.setText</h4>
 <b>setText</b>(<i>txt</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;'&#115; &#116;&#101;x&#116;.
+        Public method to set the label's text.
 </p><dl>
 <dt><i>txt</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the text to be shown (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -103,7 +103,7 @@
 <a NAME="E5SqueezeLabelPath" ID="E5SqueezeLabelPath"></a>
 <h2>E5SqueezeLabelPath</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#108;&#97;&#98;&#101;&#108; &#115;&#104;&#111;w&#105;&#110;&#103; &#97; &#102;&#105;&#108;&#101; &#112;&#97;&#116;&#104; &#99;&#111;&#109;&#112;&#97;&#99;&#116;&#101;&#100; &#116;&#111; &#102;&#105;&#116; &#105;&#116;'&#115; &#115;&#105;z&#101;.
+    Class implementing a label showing a file path compacted to fit it's size.
 </p>
 <h3>Derived from</h3>
 QLabel
@@ -115,91 +115,91 @@
 <table>
 <tr>
 <td><a href="#E5SqueezeLabelPath.__init__">E5SqueezeLabelPath</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath.length">length</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#108;&#101;&#110;&#103;&#116;&#104; &#111;&#102; &#97; &#116;&#101;x&#116; &#105;&#110; &#112;&#105;x&#101;&#108;&#115;.</td>
+<td>Public method to return the length of a text in pixels.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath.paintEvent">paintEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#115;&#111;&#109;&#101; &#112;&#97;&#105;&#110;&#116;&#105;&#110;&#103; &#105;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100;.</td>
+<td>Protected method called when some painting is required.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath.setPath">setPath</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;.</td>
+<td>Public method to set the path of the label.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath.setSurrounding">setSurrounding</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#117;&#114;&#114;&#111;&#117;&#110;&#100;&#105;&#110;&#103; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public method to set the surrounding of the path string.</td>
 </tr><tr>
 <td><a href="#E5SqueezeLabelPath.setTextPath">setTextPath</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#117;&#114;&#114;&#111;&#117;&#110;&#100;&#105;&#110;&#103; &#97;&#110;&#100; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;.</td>
+<td>Public method to set the surrounding and the path of the label.</td>
 </tr>
 </table>
 <a NAME="E5SqueezeLabelPath.__init__" ID="E5SqueezeLabelPath.__init__"></a>
 <h4>E5SqueezeLabelPath (Constructor)</h4>
 <b>E5SqueezeLabelPath</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#87;&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent Widget (QWidget)
 </dd>
 </dl><a NAME="E5SqueezeLabelPath.length" ID="E5SqueezeLabelPath.length"></a>
 <h4>E5SqueezeLabelPath.length</h4>
 <b>length</b>(<i>txt</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#108;&#101;&#110;&#103;&#116;&#104; &#111;&#102; &#97; &#116;&#101;x&#116; &#105;&#110; &#112;&#105;x&#101;&#108;&#115;.
+        Public method to return the length of a text in pixels.
 </p><dl>
 <dt><i>txt</i></dt>
 <dd>
-&#116;&#101;x&#116; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#101;&#110;&#103;&#116;&#104; &#102;&#111;&#114; &#97;&#102;&#116;&#101;&#114; w&#114;&#97;&#112;&#112;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+text to calculate the length for after wrapped (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#101;&#110;&#103;&#116;&#104; &#111;&#102; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#100; &#116;&#101;x&#116; &#105;&#110; &#112;&#105;x&#101;&#108;&#115; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+length of the wrapped text in pixels (integer)
 </dd>
 </dl><a NAME="E5SqueezeLabelPath.paintEvent" ID="E5SqueezeLabelPath.paintEvent"></a>
 <h4>E5SqueezeLabelPath.paintEvent</h4>
 <b>paintEvent</b>(<i>event</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#115;&#111;&#109;&#101; &#112;&#97;&#105;&#110;&#116;&#105;&#110;&#103; &#105;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100;.
+        Protected method called when some painting is required.
 </p><dl>
 <dt><i>event</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#105;&#110;&#116; &#101;v&#101;&#110;&#116; (&#81;&#80;&#97;&#105;&#110;&#116;&#69;v&#101;&#110;&#116;)
+reference to the paint event (QPaintEvent)
 </dd>
 </dl><a NAME="E5SqueezeLabelPath.setPath" ID="E5SqueezeLabelPath.setPath"></a>
 <h4>E5SqueezeLabelPath.setPath</h4>
 <b>setPath</b>(<i>path</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;.
+        Public method to set the path of the label.
 </p><dl>
 <dt><i>path</i></dt>
 <dd>
-&#112;&#97;&#116;&#104; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+path to be shown (string)
 </dd>
 </dl><a NAME="E5SqueezeLabelPath.setSurrounding" ID="E5SqueezeLabelPath.setSurrounding"></a>
 <h4>E5SqueezeLabelPath.setSurrounding</h4>
 <b>setSurrounding</b>(<i>surrounding</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#117;&#114;&#114;&#111;&#117;&#110;&#100;&#105;&#110;&#103; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Public method to set the surrounding of the path string.
 </p><dl>
 <dt><i>surrounding</i></dt>
 <dd>
-&#116;&#104;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#103; &#112;&#108;&#97;&#99;&#101;&#104;&#111;&#108;&#100;&#101;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#112;&#97;&#116;&#104; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the a string containg placeholders for the path (string)
 </dd>
 </dl><a NAME="E5SqueezeLabelPath.setTextPath" ID="E5SqueezeLabelPath.setTextPath"></a>
 <h4>E5SqueezeLabelPath.setTextPath</h4>
 <b>setTextPath</b>(<i>surrounding, path</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#117;&#114;&#114;&#111;&#117;&#110;&#100;&#105;&#110;&#103; &#97;&#110;&#100; &#116;&#104;&#101; &#112;&#97;&#116;&#104; &#111;&#102; &#116;&#104;&#101; &#108;&#97;&#98;&#101;&#108;.
+        Public method to set the surrounding and the path of the label.
 </p><dl>
 <dt><i>surrounding</i></dt>
 <dd>
-&#116;&#104;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#103; &#112;&#108;&#97;&#99;&#101;&#104;&#111;&#108;&#100;&#101;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#112;&#97;&#116;&#104; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the a string containg placeholders for the path (string)
 </dd><dt><i>path</i></dt>
 <dd>
-&#112;&#97;&#116;&#104; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+path to be shown (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial