src/eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncCheckPage.html

Tue, 23 Apr 2024 11:26:04 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 23 Apr 2024 11:26:04 +0200
branch
eric7
changeset 10692
9becf9ca115c
parent 10479
856476537696
permissions
-rw-r--r--

Changed the source code and the source code documentation to improve the indication of unused method/function arguments.

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.Sync.SyncCheckPage</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.Sync.SyncCheckPage</h1>
<p>
Module implementing the synchronization status wizard page.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#SyncCheckPage">SyncCheckPage</a></td>
<td>Class implementing the synchronization status wizard page.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="SyncCheckPage" ID="SyncCheckPage"></a>
<h2>SyncCheckPage</h2>
<p>
    Class implementing the synchronization status wizard page.
</p>

<h3>Derived from</h3>
QWizardPage, Ui_SyncCheckPage
<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="#SyncCheckPage.__init__">SyncCheckPage</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SyncCheckPage.__makeAnimatedLabel">__makeAnimatedLabel</a></td>
<td>Private slot to create an animated label.</td>
</tr>
<tr>
<td><a href="#SyncCheckPage.__syncError">__syncError</a></td>
<td>Private slot to handle general synchronization issues.</td>
</tr>
<tr>
<td><a href="#SyncCheckPage.__updateLabels">__updateLabels</a></td>
<td>Private slot to handle a finished synchronization event.</td>
</tr>
<tr>
<td><a href="#SyncCheckPage.__updateMessages">__updateMessages</a></td>
<td>Private slot to update the synchronization status info.</td>
</tr>
<tr>
<td><a href="#SyncCheckPage.initializePage">initializePage</a></td>
<td>Public method to initialize the page.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="SyncCheckPage.__init__" ID="SyncCheckPage.__init__"></a>
<h4>SyncCheckPage (Constructor)</h4>
<b>SyncCheckPage</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="SyncCheckPage.__makeAnimatedLabel" ID="SyncCheckPage.__makeAnimatedLabel"></a>
<h4>SyncCheckPage.__makeAnimatedLabel</h4>
<b>__makeAnimatedLabel</b>(<i>fileName, label</i>)
<p>
        Private slot to create an animated label.
</p>

<dl>

<dt><i>fileName</i> (str)</dt>
<dd>
name of the file containing the animation
</dd>
<dt><i>label</i> (EricAnimatedLabel)</dt>
<dd>
reference to the label to be animated
</dd>
</dl>
<a NAME="SyncCheckPage.__syncError" ID="SyncCheckPage.__syncError"></a>
<h4>SyncCheckPage.__syncError</h4>
<b>__syncError</b>(<i>message</i>)
<p>
        Private slot to handle general synchronization issues.
</p>

<dl>

<dt><i>message</i> (str)</dt>
<dd>
error message
</dd>
</dl>
<a NAME="SyncCheckPage.__updateLabels" ID="SyncCheckPage.__updateLabels"></a>
<h4>SyncCheckPage.__updateLabels</h4>
<b>__updateLabels</b>(<i>type_, status, _download</i>)
<p>
        Private slot to handle a finished synchronization event.
</p>

<dl>

<dt><i>type_</i> (str)</dt>
<dd>
type of the synchronization event (one of "bookmarks",
            "history", "passwords", "useragents" or "speeddial")
</dd>
<dt><i>status</i> (bool)</dt>
<dd>
flag indicating success
</dd>
<dt><i>_download</i> (bool)</dt>
<dd>
flag indicating a download of a file (unused)
</dd>
</dl>
<a NAME="SyncCheckPage.__updateMessages" ID="SyncCheckPage.__updateMessages"></a>
<h4>SyncCheckPage.__updateMessages</h4>
<b>__updateMessages</b>(<i>type_, msg</i>)
<p>
        Private slot to update the synchronization status info.
</p>

<dl>

<dt><i>type_</i> (str)</dt>
<dd>
type of synchronization data
</dd>
<dt><i>msg</i> (str)</dt>
<dd>
synchronization message
</dd>
</dl>
<a NAME="SyncCheckPage.initializePage" ID="SyncCheckPage.initializePage"></a>
<h4>SyncCheckPage.initializePage</h4>
<b>initializePage</b>(<i></i>)
<p>
        Public method to initialize the page.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial