src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.NotificationsPage.html

Fri, 27 Oct 2023 14:09:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 27 Oct 2023 14:09:40 +0200
branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10428
a071d4065202
permissions
-rw-r--r--

Regenerated the source documentation with the corrected module parser.

<!DOCTYPE html>
<html><head>
<title>eric7.Preferences.ConfigurationPages.NotificationsPage</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ConfigurationPages.NotificationsPage</h1>

<p>
Module implementing the Notifications configuration page.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#NotificationsPage">NotificationsPage</a></td>
<td>Class implementing the Notifications 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 />
<a NAME="NotificationsPage" ID="NotificationsPage"></a>
<h2>NotificationsPage</h2>

<p>
    Class implementing the Notifications configuration page.
</p>
<h3>Derived from</h3>
ConfigurationPageBase, Ui_NotificationsPage
<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="#NotificationsPage.__init__">NotificationsPage</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#NotificationsPage.__moveNotification">__moveNotification</a></td>
<td>Private slot to move the notification widget.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_criticalBgButton_clicked">on_criticalBgButton_clicked</a></td>
<td>Private slot to set the background color of the critical notifications.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_criticalDefaultButton_clicked">on_criticalDefaultButton_clicked</a></td>
<td>Private slot to reset the colors for critical notifications to their default values.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_criticalFgButton_clicked">on_criticalFgButton_clicked</a></td>
<td>Private slot to set the foreground color of the critical notifications.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_criticalResetButton_clicked">on_criticalResetButton_clicked</a></td>
<td>Private slot to reset the colors for critical notifications to their current values.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_visualButton_clicked">on_visualButton_clicked</a></td>
<td>Private slot to select the position visually.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_warningBgButton_clicked">on_warningBgButton_clicked</a></td>
<td>Private slot to set the background color of the warning notifications.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_warningDefaultButton_clicked">on_warningDefaultButton_clicked</a></td>
<td>Private slot to reset the colors for warning notifications to their default values.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_warningFgButton_clicked">on_warningFgButton_clicked</a></td>
<td>Private slot to set the foreground color of the warning notifications.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.on_warningResetButton_clicked">on_warningResetButton_clicked</a></td>
<td>Private slot to reset the colors for warning notifications to their current values.</td>
</tr>
<tr>
<td><a href="#NotificationsPage.save">save</a></td>
<td>Public slot to save the Notifications configuration.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="NotificationsPage.__init__" ID="NotificationsPage.__init__"></a>
<h4>NotificationsPage (Constructor)</h4>
<b>NotificationsPage</b>(<i></i>)

<p>
        Constructor
</p>
<a NAME="NotificationsPage.__moveNotification" ID="NotificationsPage.__moveNotification"></a>
<h4>NotificationsPage.__moveNotification</h4>
<b>__moveNotification</b>(<i></i>)

<p>
        Private slot to move the notification widget.
</p>
<a NAME="NotificationsPage.on_criticalBgButton_clicked" ID="NotificationsPage.on_criticalBgButton_clicked"></a>
<h4>NotificationsPage.on_criticalBgButton_clicked</h4>
<b>on_criticalBgButton_clicked</b>(<i></i>)

<p>
        Private slot to set the background color of the critical notifications.
</p>
<a NAME="NotificationsPage.on_criticalDefaultButton_clicked" ID="NotificationsPage.on_criticalDefaultButton_clicked"></a>
<h4>NotificationsPage.on_criticalDefaultButton_clicked</h4>
<b>on_criticalDefaultButton_clicked</b>(<i></i>)

<p>
        Private slot to reset the colors for critical notifications to their
        default values.
</p>
<a NAME="NotificationsPage.on_criticalFgButton_clicked" ID="NotificationsPage.on_criticalFgButton_clicked"></a>
<h4>NotificationsPage.on_criticalFgButton_clicked</h4>
<b>on_criticalFgButton_clicked</b>(<i></i>)

<p>
        Private slot to set the foreground color of the critical notifications.
</p>
<a NAME="NotificationsPage.on_criticalResetButton_clicked" ID="NotificationsPage.on_criticalResetButton_clicked"></a>
<h4>NotificationsPage.on_criticalResetButton_clicked</h4>
<b>on_criticalResetButton_clicked</b>(<i></i>)

<p>
        Private slot to reset the colors for critical notifications to their
        current values.
</p>
<a NAME="NotificationsPage.on_visualButton_clicked" ID="NotificationsPage.on_visualButton_clicked"></a>
<h4>NotificationsPage.on_visualButton_clicked</h4>
<b>on_visualButton_clicked</b>(<i>checked</i>)

<p>
        Private slot to select the position visually.
</p>
<dl>

<dt><i>checked</i></dt>
<dd>
state of the button (boolean)
</dd>
</dl>
<a NAME="NotificationsPage.on_warningBgButton_clicked" ID="NotificationsPage.on_warningBgButton_clicked"></a>
<h4>NotificationsPage.on_warningBgButton_clicked</h4>
<b>on_warningBgButton_clicked</b>(<i></i>)

<p>
        Private slot to set the background color of the warning notifications.
</p>
<a NAME="NotificationsPage.on_warningDefaultButton_clicked" ID="NotificationsPage.on_warningDefaultButton_clicked"></a>
<h4>NotificationsPage.on_warningDefaultButton_clicked</h4>
<b>on_warningDefaultButton_clicked</b>(<i></i>)

<p>
        Private slot to reset the colors for warning notifications to their
        default values.
</p>
<a NAME="NotificationsPage.on_warningFgButton_clicked" ID="NotificationsPage.on_warningFgButton_clicked"></a>
<h4>NotificationsPage.on_warningFgButton_clicked</h4>
<b>on_warningFgButton_clicked</b>(<i></i>)

<p>
        Private slot to set the foreground color of the warning notifications.
</p>
<a NAME="NotificationsPage.on_warningResetButton_clicked" ID="NotificationsPage.on_warningResetButton_clicked"></a>
<h4>NotificationsPage.on_warningResetButton_clicked</h4>
<b>on_warningResetButton_clicked</b>(<i></i>)

<p>
        Private slot to reset the colors for warning notifications to their
        current values.
</p>
<a NAME="NotificationsPage.save" ID="NotificationsPage.save"></a>
<h4>NotificationsPage.save</h4>
<b>save</b>(<i></i>)

<p>
        Public slot to save the Notifications configuration.
</p>
<div align="right"><a href="#top">Up</a></div>
<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>

<dt><i>dlg</i></dt>
<dd>
reference to the configuration dialog
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated page (ConfigurationPageBase)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial