Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Helpviewer.UserAgent.UserAgentManager.html

Documentation/Source/eric6.Helpviewer.UserAgent.UserAgentManager.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.UserAgent.UserAgentManager</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.Helpviewer.UserAgent.UserAgentManager</h1>
23 <p>
24 Module implementing a user agent manager.
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="#UserAgentManager">UserAgentManager</a></td>
34 <td>Class implementing a user agent manager.</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="UserAgentManager" ID="UserAgentManager"></a>
43 <h2>UserAgentManager</h2>
44 <p>
45 Class implementing a user agent manager.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>changed()</dt>
49 <dd>
50 emitted to indicate a change
51 </dd><dt>userAgentSettingsSaved()</dt>
52 <dd>
53 emitted after the user agent settings
54 were saved
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QObject
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68 <table>
69 <tr>
70 <td><a href="#UserAgentManager.__init__">UserAgentManager</a></td>
71 <td>Constructor</td>
72 </tr><tr>
73 <td><a href="#UserAgentManager.__load">__load</a></td>
74 <td>Private method to load the saved user agent settings.</td>
75 </tr><tr>
76 <td><a href="#UserAgentManager.__loadNonXml">__loadNonXml</a></td>
77 <td>Private method to load non-XML user agent files.</td>
78 </tr><tr>
79 <td><a href="#UserAgentManager.allHostNames">allHostNames</a></td>
80 <td>Public method to get a list of all host names we a user agent setting for.</td>
81 </tr><tr>
82 <td><a href="#UserAgentManager.close">close</a></td>
83 <td>Public method to close the user agents manager.</td>
84 </tr><tr>
85 <td><a href="#UserAgentManager.getFileName">getFileName</a></td>
86 <td>Public method to get the file name of the user agents file.</td>
87 </tr><tr>
88 <td><a href="#UserAgentManager.hostsCount">hostsCount</a></td>
89 <td>Public method to get the number of available user agent settings.</td>
90 </tr><tr>
91 <td><a href="#UserAgentManager.reload">reload</a></td>
92 <td>Public method to reload the user agent settings.</td>
93 </tr><tr>
94 <td><a href="#UserAgentManager.removeUserAgent">removeUserAgent</a></td>
95 <td>Public method to remove a user agent entry.</td>
96 </tr><tr>
97 <td><a href="#UserAgentManager.save">save</a></td>
98 <td>Public slot to save the user agent entries to disk.</td>
99 </tr><tr>
100 <td><a href="#UserAgentManager.setUserAgent">setUserAgent</a></td>
101 <td>Public method to set the user agent string for a host.</td>
102 </tr><tr>
103 <td><a href="#UserAgentManager.setUserAgentForUrl">setUserAgentForUrl</a></td>
104 <td>Public method to set the user agent string for an URL.</td>
105 </tr><tr>
106 <td><a href="#UserAgentManager.userAgent">userAgent</a></td>
107 <td>Public method to get the user agent setting for a host.</td>
108 </tr><tr>
109 <td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td>
110 <td>Public method to determine the user agent for the given URL.</td>
111 </tr>
112 </table>
113 <h3>Static Methods</h3>
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117 <a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a>
118 <h4>UserAgentManager (Constructor)</h4>
119 <b>UserAgentManager</b>(<i>parent=None</i>)
120 <p>
121 Constructor
122 </p><dl>
123 <dt><i>parent</i></dt>
124 <dd>
125 reference to the parent object (QObject)
126 </dd>
127 </dl><a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a>
128 <h4>UserAgentManager.__load</h4>
129 <b>__load</b>(<i></i>)
130 <p>
131 Private method to load the saved user agent settings.
132 </p><a NAME="UserAgentManager.__loadNonXml" ID="UserAgentManager.__loadNonXml"></a>
133 <h4>UserAgentManager.__loadNonXml</h4>
134 <b>__loadNonXml</b>(<i>agentFile</i>)
135 <p>
136 Private method to load non-XML user agent files.
137 </p><p>
138 This method is to convert from the old, non-XML format to the new
139 XML based format.
140 </p><dl>
141 <dt><i>agentFile</i></dt>
142 <dd>
143 name of the non-XML user agent file (string)
144 </dd>
145 </dl><a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a>
146 <h4>UserAgentManager.allHostNames</h4>
147 <b>allHostNames</b>(<i></i>)
148 <p>
149 Public method to get a list of all host names we a user agent setting
150 for.
151 </p><dl>
152 <dt>Returns:</dt>
153 <dd>
154 sorted list of all host names (list of strings)
155 </dd>
156 </dl><a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a>
157 <h4>UserAgentManager.close</h4>
158 <b>close</b>(<i></i>)
159 <p>
160 Public method to close the user agents manager.
161 </p><a NAME="UserAgentManager.getFileName" ID="UserAgentManager.getFileName"></a>
162 <h4>UserAgentManager.getFileName</h4>
163 <b>getFileName</b>(<i></i>)
164 <p>
165 Public method to get the file name of the user agents file.
166 </p><dl>
167 <dt>Returns:</dt>
168 <dd>
169 name of the user agents file (string)
170 </dd>
171 </dl><a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a>
172 <h4>UserAgentManager.hostsCount</h4>
173 <b>hostsCount</b>(<i></i>)
174 <p>
175 Public method to get the number of available user agent settings.
176 </p><dl>
177 <dt>Returns:</dt>
178 <dd>
179 number of user agent settings (integer)
180 </dd>
181 </dl><a NAME="UserAgentManager.reload" ID="UserAgentManager.reload"></a>
182 <h4>UserAgentManager.reload</h4>
183 <b>reload</b>(<i></i>)
184 <p>
185 Public method to reload the user agent settings.
186 </p><a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a>
187 <h4>UserAgentManager.removeUserAgent</h4>
188 <b>removeUserAgent</b>(<i>host</i>)
189 <p>
190 Public method to remove a user agent entry.
191 </p><dl>
192 <dt><i>host</i></dt>
193 <dd>
194 host name (string)
195 </dd>
196 </dl><a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a>
197 <h4>UserAgentManager.save</h4>
198 <b>save</b>(<i></i>)
199 <p>
200 Public slot to save the user agent entries to disk.
201 </p><a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a>
202 <h4>UserAgentManager.setUserAgent</h4>
203 <b>setUserAgent</b>(<i>host, agent</i>)
204 <p>
205 Public method to set the user agent string for a host.
206 </p><dl>
207 <dt><i>host</i></dt>
208 <dd>
209 host name (string)
210 </dd><dt><i>agent</i></dt>
211 <dd>
212 user agent string (string)
213 </dd>
214 </dl><a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a>
215 <h4>UserAgentManager.setUserAgentForUrl</h4>
216 <b>setUserAgentForUrl</b>(<i>url, agent</i>)
217 <p>
218 Public method to set the user agent string for an URL.
219 </p><dl>
220 <dt><i>url</i></dt>
221 <dd>
222 URL to register user agent setting for (QUrl)
223 </dd><dt><i>agent</i></dt>
224 <dd>
225 new current user agent string (string)
226 </dd>
227 </dl><a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a>
228 <h4>UserAgentManager.userAgent</h4>
229 <b>userAgent</b>(<i>host</i>)
230 <p>
231 Public method to get the user agent setting for a host.
232 </p><dl>
233 <dt><i>host</i></dt>
234 <dd>
235 host name (string)
236 </dd>
237 </dl><dl>
238 <dt>Returns:</dt>
239 <dd>
240 user agent string (string)
241 </dd>
242 </dl><a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a>
243 <h4>UserAgentManager.userAgentForUrl</h4>
244 <b>userAgentForUrl</b>(<i>url</i>)
245 <p>
246 Public method to determine the user agent for the given URL.
247 </p><dl>
248 <dt><i>url</i></dt>
249 <dd>
250 URL to determine user agent for (QUrl)
251 </dd>
252 </dl><dl>
253 <dt>Returns:</dt>
254 <dd>
255 user agent string (string)
256 </dd>
257 </dl>
258 <div align="right"><a href="#top">Up</a></div>
259 <hr />
260 </body></html>

Mercurial Repository: eric

eric ide

mercurial