Documentation/Source/eric5.Helpviewer.Sync.SyncHandler.html

<?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.Helpviewer.Sync.SyncHandler</title>
<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.Helpviewer.Sync.SyncHandler</h1>
<p>
Module containing a base class for synchronization handlers.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#SyncHandler">SyncHandler</a></td>
<td>Base class for synchronization handlers.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="SyncHandler" ID="SyncHandler"></a>
<h2>SyncHandler</h2>
<p>
    Base class for synchronization handlers.
</p><h3>Signals</h3>
<dl>
<dt>syncError(message)</dt>
<dd>
emitted for a general error with the error message (string)
</dd><dt>syncFinished(type_, done, download)</dt>
<dd>
emitted after a synchronization has
        finished (string one of "bookmarks", "history", "passwords" or "useragents",
        boolean, boolean)
</dd><dt>syncStatus(type_, done, message)</dt>
<dd>
emitted to indicate the synchronization
        status (string one of "bookmarks", "history", "passwords" or "useragents",
        boolean, string)
</dd>
</dl>
<h3>Derived from</h3>
QObject
<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="#SyncHandler.__init__">SyncHandler</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#SyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
<td>Public method to do the initial check.</td>
</tr><tr>
<td><a href="#SyncHandler.shutdown">shutdown</a></td>
<td>Public method to shut down the handler.</td>
</tr><tr>
<td><a href="#SyncHandler.syncBookmarks">syncBookmarks</a></td>
<td>Public method to synchronize the bookmarks.</td>
</tr><tr>
<td><a href="#SyncHandler.syncHistory">syncHistory</a></td>
<td>Public method to synchronize the history.</td>
</tr><tr>
<td><a href="#SyncHandler.syncPasswords">syncPasswords</a></td>
<td>Public method to synchronize the passwords.</td>
</tr><tr>
<td><a href="#SyncHandler.syncUserAgents">syncUserAgents</a></td>
<td>Public method to synchronize the user agents.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="SyncHandler.__init__" ID="SyncHandler.__init__"></a>
<h4>SyncHandler (Constructor)</h4>
<b>SyncHandler</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl><a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
<h4>SyncHandler.initialLoadAndCheck</h4>
<b>initialLoadAndCheck</b>(<i></i>)
<p>
        Public method to do the initial check.
</p><a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a>
<h4>SyncHandler.shutdown</h4>
<b>shutdown</b>(<i></i>)
<p>
        Public method to shut down the handler.
</p><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a>
<h4>SyncHandler.syncBookmarks</h4>
<b>syncBookmarks</b>(<i></i>)
<p>
        Public method to synchronize the bookmarks.
</p><a NAME="SyncHandler.syncHistory" ID="SyncHandler.syncHistory"></a>
<h4>SyncHandler.syncHistory</h4>
<b>syncHistory</b>(<i></i>)
<p>
        Public method to synchronize the history.
</p><a NAME="SyncHandler.syncPasswords" ID="SyncHandler.syncPasswords"></a>
<h4>SyncHandler.syncPasswords</h4>
<b>syncPasswords</b>(<i></i>)
<p>
        Public method to synchronize the passwords.
</p><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a>
<h4>SyncHandler.syncUserAgents</h4>
<b>syncUserAgents</b>(<i></i>)
<p>
        Public method to synchronize the user agents.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>