diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Preferences.ConfigurationPages.ConfigurationPageBase.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.ConfigurationPageBase.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,156 @@ +<?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.Preferences.ConfigurationPages.ConfigurationPageBase</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.Preferences.ConfigurationPages.ConfigurationPageBase</h1> +<p> +Module implementing the base class for all configuration pages. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td> +<td>Class implementing the base class for all configuration pages.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a> +<h2>ConfigurationPageBase</h2> +<p> + Class implementing the base class for all configuration pages. +</p> +<h3>Derived from</h3> +QWidget +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.initColour">initColour</a></td> +<td>Public method to initialize a colour selection button.</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> +<td>Public slot to perform some polishing actions.</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.saveState">saveState</a></td> +<td>Public method to save the current state of the widget.</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td> +<td>Public method used by the colour selection buttons.</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> +<td>Public method used by the font selection buttons.</td> +</tr><tr> +<td><a href="#ConfigurationPageBase.setState">setState</a></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> + Constructor +</p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> +<h4>ConfigurationPageBase.initColour</h4> +<b>initColour</b>(<i>colourstr, button, prefMethod</i>) +<p> + Public method to initialize a colour selection button. +</p><dl> +<dt><i>colourstr</i></dt> +<dd> +colour to be set (string) +</dd><dt><i>button</i></dt> +<dd> +reference to a button to show the colour on (QPushButton) +</dd><dt><i>prefMethod</i></dt> +<dd> +preferences method to get the colour +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +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> + 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> + 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> + Public method used by the colour selection buttons. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to a button to show the colour on (QPushButton) +</dd><dt><i>colourVar</i></dt> +<dd> +reference to the variable containing the colour (QColor) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +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> + Public method used by the font selection buttons. +</p><dl> +<dt><i>fontSample</i></dt> +<dd> +reference to the font sample widget (QLineEdit) +</dd><dt><i>fontVar</i></dt> +<dd> +reference to the variable containing the font (QFont) +</dd><dt><i>showFontInfo</i></dt> +<dd> +flag indicating to show some font info + as the sample (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +selected font (QFont) +</dd> +</dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> +<h4>ConfigurationPageBase.setState</h4> +<b>setState</b>(<i>state</i>) +<p> + Public method to set the state of the widget. +</p><dl> +<dt><i>state</i></dt> +<dd> +state data generated by saveState +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file