Documentation/Source/eric5.Helpviewer.Network.QtHelpAccessHandler.html

Fri, 11 Mar 2011 16:51:57 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 11 Mar 2011 16:51:57 +0100
changeset 945
8cd4d08fa9f6
parent 641
b06d4df23797
child 1228
7afaf2fca55b
permissions
-rw-r--r--

Made code mostly PEP 8 compliant (except all whitespace and line length).

17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>eric5.Helpviewer.Network.QtHelpAccessHandler</title>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
7 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
8 background: #EDECE6;
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
9 margin: 0em 1em 10em 1em;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
10 color: black;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
11 }
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
12
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
14 h2 { color: white; background: #85774A; }
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
15 h3 { color: white; background: #9D936E; }
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
16 h4 { color: white; background: #9D936E; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
17
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
18 a { color: #BA6D36; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
19
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body><a NAME="top" ID="top"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric5.Helpviewer.Network.QtHelpAccessHandler</h1>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
25 Module implementing a scheme access handler for QtHelp.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Global Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
641
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
29 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <h3>Classes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="#QtHelpAccessHandler">QtHelpAccessHandler</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
35 <td>Class implementing a scheme access handler for QtHelp.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <hr /><hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <a NAME="QtHelpAccessHandler" ID="QtHelpAccessHandler"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>QtHelpAccessHandler</h2>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
46 Class implementing a scheme access handler for QtHelp.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Derived from</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 SchemeAccessHandler
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h3>Class Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <h3>Methods</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="#QtHelpAccessHandler.__init__">QtHelpAccessHandler</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
58 <td>Constructor</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr><tr>
641
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
60 <td><a href="#QtHelpAccessHandler.__mimeFromUrl">__mimeFromUrl</a></td>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
61 <td>Private method to guess the mime type given an URL.</td>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
62 </tr><tr>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#QtHelpAccessHandler.createRequest">createRequest</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
64 <td>Protected method to create a request.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <a NAME="QtHelpAccessHandler.__init__" ID="QtHelpAccessHandler.__init__"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <h4>QtHelpAccessHandler (Constructor)</h4>
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 641
diff changeset
69 <b>QtHelpAccessHandler</b>(<i>engine, parent=None</i>)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
71 Constructor
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <dt><i>engine</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
75 reference to the help engine (QHelpEngine)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </dd><dt><i>parent</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
78 reference to the parent object (QObject)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </dd>
641
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
80 </dl><a NAME="QtHelpAccessHandler.__mimeFromUrl" ID="QtHelpAccessHandler.__mimeFromUrl"></a>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
81 <h4>QtHelpAccessHandler.__mimeFromUrl</h4>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
82 <b>__mimeFromUrl</b>(<i>url</i>)
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
83 <p>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
84 Private method to guess the mime type given an URL.
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
85 </p><dl>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
86 <dt><i>url</i></dt>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
87 <dd>
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
88 URL to guess the mime type from (QUrl)
b06d4df23797 Fixed an issue in the web browser related to webkit and Qt help and fixed an issue introduced by the latest refactoring.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
89 </dd>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </dl><a NAME="QtHelpAccessHandler.createRequest" ID="QtHelpAccessHandler.createRequest"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <h4>QtHelpAccessHandler.createRequest</h4>
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 641
diff changeset
92 <b>createRequest</b>(<i>op, request, outgoingData=None</i>)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
94 Protected method to create a request.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dt><i>op</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
98 the operation to be performed (QNetworkAccessManager.Operation)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 </dd><dt><i>request</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
101 reference to the request object (QNetworkRequest)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 </dd><dt><i>outgoingData</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
104 reference to an IODevice containing data to be sent
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
105 (QIODevice)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dl><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <dt>Returns:</dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
110 reference to the created reply object (QNetworkReply)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 </dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <div align="right"><a href="#top">Up</a></div>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </body></html>

eric ide

mercurial