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

Sun, 18 May 2014 14:13:09 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 18 May 2014 14:13:09 +0200
changeset 3591
2f2a4a76dd22
parent 3018
70924c0bdaf1
permissions
-rw-r--r--

Corrected a bunch of source docu issues.

2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
1 <!DOCTYPE html>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric5.Helpviewer.Network.QtHelpAccessHandler</title>
2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
4 <meta charset="UTF-8">
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
6 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
7 background: #EDECE6;
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
8 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
9 color: black;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
10 }
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
11
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
12 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 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
14 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
15 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
16
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
17 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
18
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric5.Helpviewer.Network.QtHelpAccessHandler</h1>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
24 Module implementing a scheme access handler for QtHelp.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <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
28 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <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
34 <td>Class implementing a scheme access handler for QtHelp.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <a NAME="QtHelpAccessHandler" ID="QtHelpAccessHandler"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>QtHelpAccessHandler</h2>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
45 Class implementing a scheme access handler for QtHelp.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 SchemeAccessHandler
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
53 <h3>Class Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
54 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
55 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
56 </table>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <tr>
1229
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
60 <td><a href="#QtHelpAccessHandler.__init__">QtHelpAccessHandler</a></td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
61 <td>Constructor</td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
62 </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
63 <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
64 <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
65 </tr><tr>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#QtHelpAccessHandler.createRequest">createRequest</a></td>
3591
2f2a4a76dd22 Corrected a bunch of source docu issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3018
diff changeset
67 <td>Public method to create a request.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
70 <h3>Static Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
71 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
72 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 945
diff changeset
73 </table>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <a NAME="QtHelpAccessHandler.__init__" ID="QtHelpAccessHandler.__init__"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <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
76 <b>QtHelpAccessHandler</b>(<i>engine, parent=None</i>)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
78 Constructor
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <dt><i>engine</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
82 reference to the help engine (QHelpEngine)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </dd><dt><i>parent</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
85 reference to the parent object (QObject)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </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
87 </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
88 <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
89 <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
90 <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
91 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
92 </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
93 <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
94 <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
95 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
96 </dd>
2966
f85f686981ad Regenerated source docu after corrections.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
97 </dl><dl>
f85f686981ad Regenerated source docu after corrections.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
98 <dt>Returns:</dt>
f85f686981ad Regenerated source docu after corrections.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
99 <dd>
f85f686981ad Regenerated source docu after corrections.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
100 mime type for the given URL (string)
f85f686981ad Regenerated source docu after corrections.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
101 </dd>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 </dl><a NAME="QtHelpAccessHandler.createRequest" ID="QtHelpAccessHandler.createRequest"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <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
104 <b>createRequest</b>(<i>op, request, outgoingData=None</i>)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <p>
3591
2f2a4a76dd22 Corrected a bunch of source docu issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3018
diff changeset
106 Public method to create a request.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <dt><i>op</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dd>
3018
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2966
diff changeset
110 the operation to be performed
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2966
diff changeset
111 (QNetworkAccessManager.Operation)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 </dd><dt><i>request</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
114 reference to the request object (QNetworkRequest)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </dd><dt><i>outgoingData</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
117 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
118 (QIODevice)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 </dl><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <dt>Returns:</dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
123 reference to the created reply object (QNetworkReply)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <div align="right"><a href="#top">Up</a></div>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </body></html>

eric ide

mercurial