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

<!DOCTYPE html>
<html><head>
<title>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</title>
<meta charset="UTF-8">
<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.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>Class Methods</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.__selectColourSlot">__selectColourSlot</a></td>
<td>Private slot to select a color.</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.saveColours">saveColours</a></td>
<td>Public method to save the colour selections.</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.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>
<h3>Static Methods</h3>
<table>
<tr><td>None</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.__selectColourSlot" ID="ConfigurationPageBase.__selectColourSlot"></a>
<h4>ConfigurationPageBase.__selectColourSlot</h4>
<b>__selectColourSlot</b>(<i></i>)
<p>
        Private slot to select a color.
</p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a>
<h4>ConfigurationPageBase.initColour</h4>
<b>initColour</b>(<i>colourKey, button, prefMethod, byName=False, hasAlpha=False</i>)
<p>
        Public method to initialize a colour selection button.
</p><dl>
<dt><i>colourKey</i></dt>
<dd>
key of the colour resource (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><dt><i>byName=</i></dt>
<dd>
flag indicating to retrieve/save by colour name
            (boolean)
</dd><dt><i>hasAlpha=</i></dt>
<dd>
flag indicating to allow alpha channel (boolean)
</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.saveColours" ID="ConfigurationPageBase.saveColours"></a>
<h4>ConfigurationPageBase.saveColours</h4>
<b>saveColours</b>(<i>prefMethod</i>)
<p>
        Public method to save the colour selections.
</p><dl>
<dt><i>prefMethod</i></dt>
<dd>
preferences method to set the colour
</dd>
</dl><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.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>