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

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.UserAgent.UserAgentManager</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Helpviewer.UserAgent.UserAgentManager</h1>
<p>
Module implementing a user agent manager.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#UserAgentManager">UserAgentManager</a></td>
<td>Class implementing a user agent manager.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="UserAgentManager" ID="UserAgentManager"></a>
<h2>UserAgentManager</h2>
<p>
    Class implementing a user agent manager.
</p><h3>Signals</h3>
<dl>
<dt>changed()</dt>
<dd>
emitted to indicate a change
</dd><dt>userAgentSettingsSaved()</dt>
<dd>
emitted after the user agent settings were saved
</dd>
</dl>
<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="#UserAgentManager.__init__">UserAgentManager</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#UserAgentManager.__load">__load</a></td>
<td>Private method to load the saved user agent settings.</td>
</tr><tr>
<td><a href="#UserAgentManager.__loadNonXml">__loadNonXml</a></td>
<td>Private method to load non-XML user agent files.</td>
</tr><tr>
<td><a href="#UserAgentManager.allHostNames">allHostNames</a></td>
<td>Public method to get a list of all host names we a user agent setting for.</td>
</tr><tr>
<td><a href="#UserAgentManager.close">close</a></td>
<td>Public method to close the user agents manager.</td>
</tr><tr>
<td><a href="#UserAgentManager.getFileName">getFileName</a></td>
<td>Public method to get the file name of the user agents file.</td>
</tr><tr>
<td><a href="#UserAgentManager.hostsCount">hostsCount</a></td>
<td>Public method to get the number of available user agent settings.</td>
</tr><tr>
<td><a href="#UserAgentManager.reload">reload</a></td>
<td>Public method to reload the user agent settings.</td>
</tr><tr>
<td><a href="#UserAgentManager.removeUserAgent">removeUserAgent</a></td>
<td>Public method to remove a user agent entry.</td>
</tr><tr>
<td><a href="#UserAgentManager.save">save</a></td>
<td>Public slot to save the user agent entries to disk.</td>
</tr><tr>
<td><a href="#UserAgentManager.setUserAgent">setUserAgent</a></td>
<td>Public method to set the user agent string for a host.</td>
</tr><tr>
<td><a href="#UserAgentManager.setUserAgentForUrl">setUserAgentForUrl</a></td>
<td>Public method to set the user agent string for an URL.</td>
</tr><tr>
<td><a href="#UserAgentManager.userAgent">userAgent</a></td>
<td>Public method to get the user agent setting for a host.</td>
</tr><tr>
<td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td>
<td>Publci method to determine the user agent for the given URL.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a>
<h4>UserAgentManager (Constructor)</h4>
<b>UserAgentManager</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl><a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a>
<h4>UserAgentManager.__load</h4>
<b>__load</b>(<i></i>)
<p>
        Private method to load the saved user agent settings.
</p><a NAME="UserAgentManager.__loadNonXml" ID="UserAgentManager.__loadNonXml"></a>
<h4>UserAgentManager.__loadNonXml</h4>
<b>__loadNonXml</b>(<i>agentFile</i>)
<p>
        Private method to load non-XML user agent files.
</p><p>
        This method is to convert from the old, non-XML format to the new
        XML based format.
</p><dl>
<dt><i>agentFile</i></dt>
<dd>
name of the non-XML user agent file (string)
</dd>
</dl><a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a>
<h4>UserAgentManager.allHostNames</h4>
<b>allHostNames</b>(<i></i>)
<p>
        Public method to get a list of all host names we a user agent setting for.
</p><dl>
<dt>Returns:</dt>
<dd>
sorted list of all host names (list of strings)
</dd>
</dl><a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a>
<h4>UserAgentManager.close</h4>
<b>close</b>(<i></i>)
<p>
        Public method to close the user agents manager.
</p><a NAME="UserAgentManager.getFileName" ID="UserAgentManager.getFileName"></a>
<h4>UserAgentManager.getFileName</h4>
<b>getFileName</b>(<i></i>)
<p>
        Public method to get the file name of the user agents file.
</p><dl>
<dt>Returns:</dt>
<dd>
name of the user agents file (string)
</dd>
</dl><a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a>
<h4>UserAgentManager.hostsCount</h4>
<b>hostsCount</b>(<i></i>)
<p>
        Public method to get the number of available user agent settings.
</p><dl>
<dt>Returns:</dt>
<dd>
number of user agent settings (integer)
</dd>
</dl><a NAME="UserAgentManager.reload" ID="UserAgentManager.reload"></a>
<h4>UserAgentManager.reload</h4>
<b>reload</b>(<i></i>)
<p>
        Public method to reload the user agent settings.
</p><a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a>
<h4>UserAgentManager.removeUserAgent</h4>
<b>removeUserAgent</b>(<i>host</i>)
<p>
        Public method to remove a user agent entry.
</p><dl>
<dt><i>host</i></dt>
<dd>
host name (string)
</dd>
</dl><a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a>
<h4>UserAgentManager.save</h4>
<b>save</b>(<i></i>)
<p>
        Public slot to save the user agent entries to disk.
</p><a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a>
<h4>UserAgentManager.setUserAgent</h4>
<b>setUserAgent</b>(<i>host, agent</i>)
<p>
        Public method to set the user agent string for a host.
</p><dl>
<dt><i>host</i></dt>
<dd>
host name (string)
</dd><dt><i>agent</i></dt>
<dd>
user agent string (string)
</dd>
</dl><a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a>
<h4>UserAgentManager.setUserAgentForUrl</h4>
<b>setUserAgentForUrl</b>(<i>url, agent</i>)
<p>
        Public method to set the user agent string for an URL.
</p><dl>
<dt><i>url</i></dt>
<dd>
URL to register user agent setting for (QUrl)
</dd><dt><i>agent</i></dt>
<dd>
new current user agent string (string)
</dd>
</dl><a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a>
<h4>UserAgentManager.userAgent</h4>
<b>userAgent</b>(<i>host</i>)
<p>
        Public method to get the user agent setting for a host.
</p><dl>
<dt><i>host</i></dt>
<dd>
host name (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
user agent string (string)
</dd>
</dl><a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a>
<h4>UserAgentManager.userAgentForUrl</h4>
<b>userAgentForUrl</b>(<i>url</i>)
<p>
        Publci method to determine the user agent for the given URL.
</p><dl>
<dt><i>url</i></dt>
<dd>
URL to determine user agent for (QUrl)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
user agent string (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>