diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.DiffColoursPage.html --- a/eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.DiffColoursPage.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.DiffColoursPage.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,160 +18,213 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Preferences.ConfigurationPages.DiffColoursPage</h1> + <p> Module implementing the Diff colours configuration page. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#DiffColoursPage">DiffColoursPage</a></td> <td>Class implementing the Diff colours configuration page.</td> </tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#create">create</a></td> <td>Module function to create the configuration page.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="DiffColoursPage" ID="DiffColoursPage"></a> <h2>DiffColoursPage</h2> + <p> Class implementing the Diff colours configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_DiffColoursPage <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="#DiffColoursPage.__init__">DiffColoursPage</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.__initColour">__initColour</a></td> <td>Private method to initialize a colour selection button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.__selectBackgroundColour">__selectBackgroundColour</a></td> <td>Private slot to select a background colour.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.__selectTextColour">__selectTextColour</a></td> <td>Private slot to select the text colour.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.__updateSampleBackgroundColour">__updateSampleBackgroundColour</a></td> <td>Private slot to update the background colour of a sample.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.__updateSampleTextColour">__updateSampleTextColour</a></td> <td>Private slot to update the text colour of all samples.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DiffColoursPage.save">save</a></td> <td>Public slot to save the Diff colours configuration.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a> <h4>DiffColoursPage (Constructor)</h4> <b>DiffColoursPage</b>(<i></i>) + <p> Constructor -</p><a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a> +</p> +<a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a> <h4>DiffColoursPage.__initColour</h4> <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>) + <p> Private method to initialize a colour selection button. -</p><dl> +</p> +<dl> + <dt><i>colourKey</i> (str)</dt> <dd> key of the diff colour -</dd><dt><i>button</i> (QPushButton)</dt> +</dd> +<dt><i>button</i> (QPushButton)</dt> <dd> reference to the button -</dd><dt><i>initSlot</i> (func)</dt> +</dd> +<dt><i>initSlot</i> (func)</dt> <dd> slot to be called to initialize the sample -</dd><dt><i>selectSlot</i> (func)</dt> +</dd> +<dt><i>selectSlot</i> (func)</dt> <dd> slot to be called to select the colour -</dd><dt><i>sampleWidget</i> (QLineEdit)</dt> +</dd> +<dt><i>sampleWidget</i> (QLineEdit)</dt> <dd> reference to the sample widget </dd> -</dl><a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a> +</dl> +<a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a> <h4>DiffColoursPage.__selectBackgroundColour</h4> <b>__selectBackgroundColour</b>(<i>button</i>) + <p> Private slot to select a background colour. -</p><dl> +</p> +<dl> + <dt><i>button</i> (QPushButton)</dt> <dd> reference to the button been pressed </dd> -</dl><a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a> +</dl> +<a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a> <h4>DiffColoursPage.__selectTextColour</h4> <b>__selectTextColour</b>(<i>button</i>) + <p> Private slot to select the text colour. -</p><dl> +</p> +<dl> + <dt><i>button</i> (QPushButton)</dt> <dd> reference to the button been pressed </dd> -</dl><a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a> +</dl> +<a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a> <h4>DiffColoursPage.__updateSampleBackgroundColour</h4> <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>) + <p> Private slot to update the background colour of a sample. -</p><dl> +</p> +<dl> + <dt><i>colourKey</i> (str)</dt> <dd> key of the diff colour </dd> -</dl><a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a> +</dl> +<a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a> <h4>DiffColoursPage.__updateSampleTextColour</h4> <b>__updateSampleTextColour</b>(<i>colourKey</i>) + <p> Private slot to update the text colour of all samples. -</p><dl> +</p> +<dl> + <dt><i>colourKey</i> (str)</dt> <dd> key of the diff colour </dd> -</dl><a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a> +</dl> +<a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a> <h4>DiffColoursPage.save</h4> <b>save</b>(<i></i>) + <p> Public slot to save the Diff colours configuration. </p> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="create" ID="create"></a> <h2>create</h2> <b>create</b>(<i>dlg</i>) + <p> Module function to create the configuration page. -</p><dl> +</p> +<dl> + <dt><i>dlg</i></dt> <dd> reference to the configuration dialog </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the instantiated page (ConfigurationPageBase)