Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.WebBrowser.Sync.SyncHandler.html

eric6/Documentation/Source/eric6.WebBrowser.Sync.SyncHandler.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
--- a/eric6/Documentation/Source/eric6.WebBrowser.Sync.SyncHandler.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.WebBrowser.Sync.SyncHandler.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,47 +18,60 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.WebBrowser.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 />
+<hr />
+<hr />
 <a NAME="SyncHandler" ID="SyncHandler"></a>
 <h2>SyncHandler</h2>
+
 <p>
     Base class for synchronization handlers.
-</p><h3>Signals</h3>
+</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>
+<dt>syncFinished(type_, done, download)</dt>
 <dd>
 emitted after a
         synchronization has finished (string one of "bookmarks", "history",
         "passwords", "useragents" or "speeddial", boolean, boolean)
-</dd><dt>syncMessage(message)</dt>
+</dd>
+<dt>syncMessage(message)</dt>
 <dd>
 emitted to send a message about
         synchronization (string)
-</dd><dt>syncStatus(type_, message)</dt>
+</dd>
+<dt>syncStatus(type_, message)</dt>
 <dd>
 emitted to indicate the synchronization
         status (string one of "bookmarks", "history", "passwords",
@@ -68,192 +81,256 @@
 <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>
+</tr>
+<tr>
 <td><a href="#SyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
 <td>Public method to do the initial check.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.readFile">readFile</a></td>
 <td>Public method to read a file.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.shutdown">shutdown</a></td>
 <td>Public method to shut down the handler.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.syncBookmarks">syncBookmarks</a></td>
 <td>Public method to synchronize the bookmarks.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.syncHistory">syncHistory</a></td>
 <td>Public method to synchronize the history.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.syncPasswords">syncPasswords</a></td>
 <td>Public method to synchronize the passwords.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.syncSpeedDial">syncSpeedDial</a></td>
 <td>Public method to synchronize the speed dial data.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.syncUserAgents">syncUserAgents</a></td>
 <td>Public method to synchronize the user agents.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyncHandler.writeFile">writeFile</a></td>
 <td>Public method to write the data to a file.</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>
+</p>
+<dl>
+
 <dt><i>parent</i></dt>
 <dd>
 reference to the parent object (QObject)
 </dd>
-</dl><a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
+</dl>
+<a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
 <h4>SyncHandler.initialLoadAndCheck</h4>
 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
+
 <p>
         Public method to do the initial check.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>forceUpload=</i></dt>
 <dd>
 flag indicating a forced upload of the files
             (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.readFile" ID="SyncHandler.readFile"></a>
+</dl>
+<a NAME="SyncHandler.readFile" ID="SyncHandler.readFile"></a>
 <h4>SyncHandler.readFile</h4>
 <b>readFile</b>(<i>fileName, type_</i>)
+
 <p>
         Public method to read a file.
-</p><p>
+</p>
+<p>
         If encrypted synchronization is enabled, the data will be encrypted
         using the relevant encryption key.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>fileName</i></dt>
 <dd>
 name of the file to be read (string)
-</dd><dt><i>type_</i></dt>
+</dd>
+<dt><i>type_</i></dt>
 <dd>
 type of the synchronization event (string one
             of "bookmarks", "history", "passwords", "useragents" or
             "speeddial")
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 data of the file, optionally encrypted (QByteArray)
 </dd>
-</dl><a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a>
+</dl>
+<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><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a>
+</dl>
+<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><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.syncHistory" ID="SyncHandler.syncHistory"></a>
+</dl>
+<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><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.syncPasswords" ID="SyncHandler.syncPasswords"></a>
+</dl>
+<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><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.syncSpeedDial" ID="SyncHandler.syncSpeedDial"></a>
+</dl>
+<a NAME="SyncHandler.syncSpeedDial" ID="SyncHandler.syncSpeedDial"></a>
 <h4>SyncHandler.syncSpeedDial</h4>
 <b>syncSpeedDial</b>(<i></i>)
+
 <p>
         Public method to synchronize the speed dial data.
-</p><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a>
+</dl>
+<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><dl>
+</p>
+<dl>
+
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
 raised to indicate that this method
             must be implemented by subclasses
 </dd>
-</dl><a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a>
+</dl>
+<a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a>
 <h4>SyncHandler.writeFile</h4>
 <b>writeFile</b>(<i>data, fileName, type_, timestamp=0</i>)
+
 <p>
         Public method to write the data to a file.
-</p><p>
+</p>
+<p>
         If encrypted synchronization is enabled, the data will be decrypted
         using the relevant encryption key.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>data</i></dt>
 <dd>
 data to be written and optionally decrypted (QByteArray)
-</dd><dt><i>fileName</i></dt>
+</dd>
+<dt><i>fileName</i></dt>
 <dd>
 name of the file the data is to be written to (string)
-</dd><dt><i>type_</i></dt>
+</dd>
+<dt><i>type_</i></dt>
 <dd>
 type of the synchronization event (string one
             of "bookmarks", "history", "passwords", "useragents" or
             "speeddial")
-</dd><dt><i>timestamp</i></dt>
+</dd>
+<dt><i>timestamp</i></dt>
 <dd>
 timestamp to be given to the file (int)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple giving a success flag and an error string (boolean,

Mercurial Repository: eric

eric ide

mercurial