Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.WebBrowser.Sync.DirectorySyncHandler.html

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

changeset 4918
71caf42a13d8
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.Sync.DirectorySyncHandler</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Sync.DirectorySyncHandler</h1>
23 <p>
24 Module implementing a synchronization handler using a shared directory.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#DirectorySyncHandler">DirectorySyncHandler</a></td>
34 <td>Class implementing a synchronization handler using a shared directory.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="DirectorySyncHandler" ID="DirectorySyncHandler"></a>
43 <h2>DirectorySyncHandler</h2>
44 <p>
45 Class implementing a synchronization handler using a shared directory.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>syncError(message)</dt>
49 <dd>
50 emitted for a general error with the error
51 message (string)
52 </dd><dt>syncFinished(type_, done, download)</dt>
53 <dd>
54 emitted after a
55 synchronization has finished (string one of "bookmarks", "history",
56 "passwords", "useragents" or "speeddial", boolean, boolean)
57 </dd><dt>syncMessage(message)</dt>
58 <dd>
59 emitted to send a message about
60 synchronization (string)
61 </dd><dt>syncStatus(type_, message)</dt>
62 <dd>
63 emitted to indicate the synchronization
64 status (string one of "bookmarks", "history", "passwords",
65 "useragents" or "speeddial", string)
66 </dd>
67 </dl>
68 <h3>Derived from</h3>
69 SyncHandler
70 <h3>Class Attributes</h3>
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74 <h3>Class Methods</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Methods</h3>
79 <table>
80 <tr>
81 <td><a href="#DirectorySyncHandler.__init__">DirectorySyncHandler</a></td>
82 <td>Constructor</td>
83 </tr><tr>
84 <td><a href="#DirectorySyncHandler.__downloadFile">__downloadFile</a></td>
85 <td>Private method to downlaod the given file.</td>
86 </tr><tr>
87 <td><a href="#DirectorySyncHandler.__initialSync">__initialSync</a></td>
88 <td>Private slot to do the initial synchronization.</td>
89 </tr><tr>
90 <td><a href="#DirectorySyncHandler.__initialSyncFile">__initialSyncFile</a></td>
91 <td>Private method to do the initial synchronization of the given file.</td>
92 </tr><tr>
93 <td><a href="#DirectorySyncHandler.__syncFile">__syncFile</a></td>
94 <td>Private method to synchronize the given file.</td>
95 </tr><tr>
96 <td><a href="#DirectorySyncHandler.__uploadFile">__uploadFile</a></td>
97 <td>Private method to upload the given file.</td>
98 </tr><tr>
99 <td><a href="#DirectorySyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
100 <td>Public method to do the initial check.</td>
101 </tr><tr>
102 <td><a href="#DirectorySyncHandler.shutdown">shutdown</a></td>
103 <td>Public method to shut down the handler.</td>
104 </tr><tr>
105 <td><a href="#DirectorySyncHandler.syncBookmarks">syncBookmarks</a></td>
106 <td>Public method to synchronize the bookmarks.</td>
107 </tr><tr>
108 <td><a href="#DirectorySyncHandler.syncHistory">syncHistory</a></td>
109 <td>Public method to synchronize the history.</td>
110 </tr><tr>
111 <td><a href="#DirectorySyncHandler.syncPasswords">syncPasswords</a></td>
112 <td>Public method to synchronize the passwords.</td>
113 </tr><tr>
114 <td><a href="#DirectorySyncHandler.syncSpeedDial">syncSpeedDial</a></td>
115 <td>Public method to synchronize the speed dial data.</td>
116 </tr><tr>
117 <td><a href="#DirectorySyncHandler.syncUserAgents">syncUserAgents</a></td>
118 <td>Public method to synchronize the user agents.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="DirectorySyncHandler.__init__" ID="DirectorySyncHandler.__init__"></a>
126 <h4>DirectorySyncHandler (Constructor)</h4>
127 <b>DirectorySyncHandler</b>(<i>parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>parent</i></dt>
132 <dd>
133 reference to the parent object (QObject)
134 </dd>
135 </dl><a NAME="DirectorySyncHandler.__downloadFile" ID="DirectorySyncHandler.__downloadFile"></a>
136 <h4>DirectorySyncHandler.__downloadFile</h4>
137 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>)
138 <p>
139 Private method to downlaod the given file.
140 </p><dl>
141 <dt><i>type_</i></dt>
142 <dd>
143 type of the synchronization event (string one
144 of "bookmarks", "history", "passwords", "useragents" or
145 "speeddial")
146 </dd><dt><i>fileName</i></dt>
147 <dd>
148 name of the file to be downloaded (string)
149 </dd><dt><i>timestamp</i></dt>
150 <dd>
151 time stamp in seconds of the file to be downloaded
152 (integer)
153 </dd>
154 </dl><a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a>
155 <h4>DirectorySyncHandler.__initialSync</h4>
156 <b>__initialSync</b>(<i></i>)
157 <p>
158 Private slot to do the initial synchronization.
159 </p><a NAME="DirectorySyncHandler.__initialSyncFile" ID="DirectorySyncHandler.__initialSyncFile"></a>
160 <h4>DirectorySyncHandler.__initialSyncFile</h4>
161 <b>__initialSyncFile</b>(<i>type_, fileName</i>)
162 <p>
163 Private method to do the initial synchronization of the given file.
164 </p><dl>
165 <dt><i>type_</i></dt>
166 <dd>
167 type of the synchronization event (string one
168 of "bookmarks", "history", "passwords", "useragents" or
169 "speeddial")
170 </dd><dt><i>fileName</i></dt>
171 <dd>
172 name of the file to be synchronized (string)
173 </dd>
174 </dl><a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a>
175 <h4>DirectorySyncHandler.__syncFile</h4>
176 <b>__syncFile</b>(<i>type_, fileName</i>)
177 <p>
178 Private method to synchronize the given file.
179 </p><dl>
180 <dt><i>type_</i></dt>
181 <dd>
182 type of the synchronization event (string one
183 of "bookmarks", "history", "passwords", "useragents" or
184 "speeddial")
185 </dd><dt><i>fileName</i></dt>
186 <dd>
187 name of the file to be synchronized (string)
188 </dd>
189 </dl><a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a>
190 <h4>DirectorySyncHandler.__uploadFile</h4>
191 <b>__uploadFile</b>(<i>type_, fileName</i>)
192 <p>
193 Private method to upload the given file.
194 </p><dl>
195 <dt><i>type_</i></dt>
196 <dd>
197 type of the synchronization event (string one
198 of "bookmarks", "history", "passwords", "useragents" or
199 "speeddial")
200 </dd><dt><i>fileName</i></dt>
201 <dd>
202 name of the file to be uploaded (string)
203 </dd>
204 </dl><a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a>
205 <h4>DirectorySyncHandler.initialLoadAndCheck</h4>
206 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
207 <p>
208 Public method to do the initial check.
209 </p><dl>
210 <dt><i>forceUpload=</i></dt>
211 <dd>
212 flag indicating a forced upload of the files
213 (boolean)
214 </dd>
215 </dl><a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a>
216 <h4>DirectorySyncHandler.shutdown</h4>
217 <b>shutdown</b>(<i></i>)
218 <p>
219 Public method to shut down the handler.
220 </p><a NAME="DirectorySyncHandler.syncBookmarks" ID="DirectorySyncHandler.syncBookmarks"></a>
221 <h4>DirectorySyncHandler.syncBookmarks</h4>
222 <b>syncBookmarks</b>(<i></i>)
223 <p>
224 Public method to synchronize the bookmarks.
225 </p><a NAME="DirectorySyncHandler.syncHistory" ID="DirectorySyncHandler.syncHistory"></a>
226 <h4>DirectorySyncHandler.syncHistory</h4>
227 <b>syncHistory</b>(<i></i>)
228 <p>
229 Public method to synchronize the history.
230 </p><a NAME="DirectorySyncHandler.syncPasswords" ID="DirectorySyncHandler.syncPasswords"></a>
231 <h4>DirectorySyncHandler.syncPasswords</h4>
232 <b>syncPasswords</b>(<i></i>)
233 <p>
234 Public method to synchronize the passwords.
235 </p><a NAME="DirectorySyncHandler.syncSpeedDial" ID="DirectorySyncHandler.syncSpeedDial"></a>
236 <h4>DirectorySyncHandler.syncSpeedDial</h4>
237 <b>syncSpeedDial</b>(<i></i>)
238 <p>
239 Public method to synchronize the speed dial data.
240 </p><a NAME="DirectorySyncHandler.syncUserAgents" ID="DirectorySyncHandler.syncUserAgents"></a>
241 <h4>DirectorySyncHandler.syncUserAgents</h4>
242 <b>syncUserAgents</b>(<i></i>)
243 <p>
244 Public method to synchronize the user agents.
245 </p>
246 <div align="right"><a href="#top">Up</a></div>
247 <hr />
248 </body></html>

Mercurial Repository: eric

eric ide

mercurial