Documentation/Source/eric5.Helpviewer.UserAgent.UserAgentWriter.html

changeset 1687
5efcb0cea376
child 2367
78f6c8193d37
equal deleted inserted replaced
1686:bd756cb42d5b 1687:5efcb0cea376
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.UserAgent.UserAgentWriter</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.UserAgent.UserAgentWriter</h1>
24 <p>
25 Module implementing a class to write user agent data files.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#UserAgentWriter">UserAgentWriter</a></td>
35 <td>Class implementing a writer object to generate user agent data files.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="UserAgentWriter" ID="UserAgentWriter"></a>
44 <h2>UserAgentWriter</h2>
45 <p>
46 Class implementing a writer object to generate user agent data files.
47 </p>
48 <h3>Derived from</h3>
49 QXmlStreamWriter
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#UserAgentWriter.__init__">UserAgentWriter</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#UserAgentWriter.__write">__write</a></td>
65 <td>Private method to write a user agent file.</td>
66 </tr><tr>
67 <td><a href="#UserAgentWriter.write">write</a></td>
68 <td>Public method to write a user agent data file.</td>
69 </tr>
70 </table>
71 <h3>Static Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <a NAME="UserAgentWriter.__init__" ID="UserAgentWriter.__init__"></a>
76 <h4>UserAgentWriter (Constructor)</h4>
77 <b>UserAgentWriter</b>(<i></i>)
78 <p>
79 Constructor
80 </p><a NAME="UserAgentWriter.__write" ID="UserAgentWriter.__write"></a>
81 <h4>UserAgentWriter.__write</h4>
82 <b>__write</b>(<i>agents</i>)
83 <p>
84 Private method to write a user agent file.
85 </p><dl>
86 <dt><i>agents</i></dt>
87 <dd>
88 dictionary with user agent data (host as key, agent string as value)
89 </dd>
90 </dl><dl>
91 <dt>Returns:</dt>
92 <dd>
93 flag indicating success (boolean)
94 </dd>
95 </dl><a NAME="UserAgentWriter.write" ID="UserAgentWriter.write"></a>
96 <h4>UserAgentWriter.write</h4>
97 <b>write</b>(<i>fileNameOrDevice, agents</i>)
98 <p>
99 Public method to write a user agent data file.
100 </p><dl>
101 <dt><i>fileNameOrDevice</i></dt>
102 <dd>
103 name of the file to write (string)
104 or device to write to (QIODevice)
105 </dd><dt><i>agents</i></dt>
106 <dd>
107 dictionary with user agent data (host as key, agent string as value)
108 </dd>
109 </dl>
110 <div align="right"><a href="#top">Up</a></div>
111 <hr />
112 </body></html>

eric ide

mercurial