Documentation/Source/eric5.Preferences.ConfigurationPages.ConfigurationPageBase.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.ConfigurationPageBase.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.ConfigurationPageBase.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;.
+Module implementing the base class for all configuration pages.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;.</td>
+<td>Class implementing the base class for all configuration pages.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a>
 <h2>ConfigurationPageBase</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;.
+    Class implementing the base class for all configuration pages.
 </p>
 <h3>Derived from</h3>
 QWidget
@@ -55,112 +55,112 @@
 <table>
 <tr>
 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Public method to initialize a colour selection button.</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#112;&#111;&#108;&#105;&#115;&#104;&#105;&#110;&#103; &#97;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Public slot to perform some polishing actions.</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#97;v&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.</td>
+<td>Public method to save the current state of the widget.</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.</td>
+<td>Public method used by the colour selection buttons.</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.</td>
+<td>Public method used by the font selection buttons.</td>
 </tr><tr>
 <td><a href="#ConfigurationPageBase.setState">setState</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.</td>
+<td>Public method to set the state of the widget.</td>
 </tr>
 </table>
 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a>
 <h4>ConfigurationPageBase (Constructor)</h4>
 <b>ConfigurationPageBase</b>(<i></i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a>
 <h4>ConfigurationPageBase.initColour</h4>
 <b>initColour</b>(<i>colourstr, button, prefMethod</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;.
+        Public method to initialize a colour selection button.
 </p><dl>
 <dt><i>colourstr</i></dt>
 <dd>
-&#99;&#111;&#108;&#111;&#117;&#114; &#116;&#111; &#98;&#101; &#115;&#101;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+colour to be set (string)
 </dd><dt><i>button</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#111;&#110; (&#81;&#80;&#117;&#115;&#104;&#66;&#117;&#116;&#116;&#111;&#110;)
+reference to a button to show the colour on (QPushButton)
 </dd><dt><i>prefMethod</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114;
+preferences method to get the colour
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#114;&#101;&#97;&#116;&#101;&#100; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;)
+reference to the created colour (QColor)
 </dd>
 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a>
 <h4>ConfigurationPageBase.polishPage</h4>
 <b>polishPage</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#112;&#111;&#108;&#105;&#115;&#104;&#105;&#110;&#103; &#97;&#99;&#116;&#105;&#111;&#110;&#115;.
+        Public slot to perform some polishing actions.
 </p><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a>
 <h4>ConfigurationPageBase.saveState</h4>
 <b>saveState</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#97;v&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.
+        Public method to save the current state of the widget.
 </p><a NAME="ConfigurationPageBase.selectColour" ID="ConfigurationPageBase.selectColour"></a>
 <h4>ConfigurationPageBase.selectColour</h4>
 <b>selectColour</b>(<i>button, colourVar</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.
+        Public method used by the colour selection buttons.
 </p><dl>
 <dt><i>button</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#111;&#110; (&#81;&#80;&#117;&#115;&#104;&#66;&#117;&#116;&#116;&#111;&#110;)
+reference to a button to show the colour on (QPushButton)
 </dd><dt><i>colourVar</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#97;&#114;&#105;&#97;&#98;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;)
+reference to the variable containing the colour (QColor)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;)
+selected colour (QColor)
 </dd>
 </dl><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a>
 <h4>ConfigurationPageBase.selectFont</h4>
 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo = False</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.
+        Public method used by the font selection buttons.
 </p><dl>
 <dt><i>fontSample</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#97;&#109;&#112;&#108;&#101; w&#105;&#100;&#103;&#101;&#116; (&#81;&#76;&#105;&#110;&#101;&#69;&#100;&#105;&#116;)
+reference to the font sample widget (QLineEdit)
 </dd><dt><i>fontVar</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#97;&#114;&#105;&#97;&#98;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#111;&#110;&#116; (&#81;&#70;&#111;&#110;&#116;)
+reference to the variable containing the font (QFont)
 </dd><dt><i>showFontInfo</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w &#115;&#111;&#109;&#101; &#102;&#111;&#110;&#116; &#105;&#110;&#102;&#111;
-            &#97;&#115; &#116;&#104;&#101; &#115;&#97;&#109;&#112;&#108;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating to show some font info
+            as the sample (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#111;&#110;&#116; (&#81;&#70;&#111;&#110;&#116;)
+selected font (QFont)
 </dd>
 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a>
 <h4>ConfigurationPageBase.setState</h4>
 <b>setState</b>(<i>state</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.
+        Public method to set the state of the widget.
 </p><dl>
 <dt><i>state</i></dt>
 <dd>
-&#115;&#116;&#97;&#116;&#101; &#100;&#97;&#116;&#97; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#98;y &#115;&#97;v&#101;&#83;&#116;&#97;&#116;&#101;
+state data generated by saveState
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial