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

changeset 1596
8d59e4f3c828
child 1621
85653d5d3bf9
equal deleted inserted replaced
1593:470b03ae90e7 1596:8d59e4f3c828
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.UserAgentManager</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.UserAgentManager</h1>
24 <p>
25 Module implementing a user agent manager.
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="#UserAgentManager">UserAgentManager</a></td>
35 <td>Class implementing a user agent manager.</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="UserAgentManager" ID="UserAgentManager"></a>
44 <h2>UserAgentManager</h2>
45 <p>
46 Class implementing a user agent manager.
47 </p><h3>Signals</h3>
48 <dl>
49 <dt>changed()</dt>
50 <dd>
51 emitted to indicate a change
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QObject
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#UserAgentManager.__init__">UserAgentManager</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#UserAgentManager.__load">__load</a></td>
71 <td>Private method to load the saved user agent settings.</td>
72 </tr><tr>
73 <td><a href="#UserAgentManager.allHostNames">allHostNames</a></td>
74 <td>Public method to get a list of all host names we a user agent setting for.</td>
75 </tr><tr>
76 <td><a href="#UserAgentManager.close">close</a></td>
77 <td>Public method to close the user agents manager.</td>
78 </tr><tr>
79 <td><a href="#UserAgentManager.hostsCount">hostsCount</a></td>
80 <td>Public method to get the number of available user agent settings.</td>
81 </tr><tr>
82 <td><a href="#UserAgentManager.removeUserAgent">removeUserAgent</a></td>
83 <td>Public method to remove a user agent entry.</td>
84 </tr><tr>
85 <td><a href="#UserAgentManager.save">save</a></td>
86 <td>Public slot to save the user agent entries to disk.</td>
87 </tr><tr>
88 <td><a href="#UserAgentManager.setUserAgent">setUserAgent</a></td>
89 <td>Public method to set the user agent string for a host.</td>
90 </tr><tr>
91 <td><a href="#UserAgentManager.setUserAgentForUrl">setUserAgentForUrl</a></td>
92 <td>Public method to set the user agent string for an URL.</td>
93 </tr><tr>
94 <td><a href="#UserAgentManager.userAgent">userAgent</a></td>
95 <td>Public method to get the user agent setting for a host.</td>
96 </tr><tr>
97 <td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td>
98 <td>Publci method to determine the user agent for the given URL.</td>
99 </tr>
100 </table>
101 <h3>Static Methods</h3>
102 <table>
103 <tr><td>None</td></tr>
104 </table>
105 <a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a>
106 <h4>UserAgentManager (Constructor)</h4>
107 <b>UserAgentManager</b>(<i>parent=None</i>)
108 <p>
109 Constructor
110 </p><dl>
111 <dt><i>parent</i></dt>
112 <dd>
113 reference to the parent object (QObject)
114 </dd>
115 </dl><a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a>
116 <h4>UserAgentManager.__load</h4>
117 <b>__load</b>(<i></i>)
118 <p>
119 Private method to load the saved user agent settings.
120 </p><a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a>
121 <h4>UserAgentManager.allHostNames</h4>
122 <b>allHostNames</b>(<i></i>)
123 <p>
124 Public method to get a list of all host names we a user agent setting for.
125 </p><dl>
126 <dt>Returns:</dt>
127 <dd>
128 sorted list of all host names (list of strings)
129 </dd>
130 </dl><a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a>
131 <h4>UserAgentManager.close</h4>
132 <b>close</b>(<i></i>)
133 <p>
134 Public method to close the user agents manager.
135 </p><a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a>
136 <h4>UserAgentManager.hostsCount</h4>
137 <b>hostsCount</b>(<i></i>)
138 <p>
139 Public method to get the number of available user agent settings.
140 </p><dl>
141 <dt>Returns:</dt>
142 <dd>
143 number of user agent settings (integer)
144 </dd>
145 </dl><a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a>
146 <h4>UserAgentManager.removeUserAgent</h4>
147 <b>removeUserAgent</b>(<i>host</i>)
148 <p>
149 Public method to remove a user agent entry.
150 </p><dl>
151 <dt><i>host</i></dt>
152 <dd>
153 host name (string)
154 </dd>
155 </dl><a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a>
156 <h4>UserAgentManager.save</h4>
157 <b>save</b>(<i></i>)
158 <p>
159 Public slot to save the user agent entries to disk.
160 </p><a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a>
161 <h4>UserAgentManager.setUserAgent</h4>
162 <b>setUserAgent</b>(<i>host, agent</i>)
163 <p>
164 Public method to set the user agent string for a host.
165 </p><dl>
166 <dt><i>host</i></dt>
167 <dd>
168 host name (string)
169 </dd><dt><i>agent</i></dt>
170 <dd>
171 user agent string (string)
172 </dd>
173 </dl><a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a>
174 <h4>UserAgentManager.setUserAgentForUrl</h4>
175 <b>setUserAgentForUrl</b>(<i>url, agent</i>)
176 <p>
177 Public method to set the user agent string for an URL.
178 </p><dl>
179 <dt><i>url</i></dt>
180 <dd>
181 URL to register user agent setting for (QUrl)
182 </dd><dt><i>agent</i></dt>
183 <dd>
184 new current user agent string (string)
185 </dd>
186 </dl><a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a>
187 <h4>UserAgentManager.userAgent</h4>
188 <b>userAgent</b>(<i>host</i>)
189 <p>
190 Public method to get the user agent setting for a host.
191 </p><dl>
192 <dt><i>host</i></dt>
193 <dd>
194 host name (string)
195 </dd>
196 </dl><dl>
197 <dt>Returns:</dt>
198 <dd>
199 user agent string (string)
200 </dd>
201 </dl><a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a>
202 <h4>UserAgentManager.userAgentForUrl</h4>
203 <b>userAgentForUrl</b>(<i>url</i>)
204 <p>
205 Publci method to determine the user agent for the given URL.
206 </p><dl>
207 <dt><i>url</i></dt>
208 <dd>
209 URL to determine user agent for (QUrl)
210 </dd>
211 </dl><dl>
212 <dt>Returns:</dt>
213 <dd>
214 user agent string (string)
215 </dd>
216 </dl>
217 <div align="right"><a href="#top">Up</a></div>
218 <hr />
219 </body></html>

eric ide

mercurial