eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpTopicDialog.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7989
a21d673a8f99
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.WebBrowser.QtHelp.HelpTopicDialog</title>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
22 <a NAME="top" ID="top"></a>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.WebBrowser.QtHelp.HelpTopicDialog</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
24
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing a dialog to select a help topic to display.
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
29
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
36
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#HelpTopicDialog">HelpTopicDialog</a></td>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing a dialog to select a help topic to display.</td>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr><td>None</td></tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
47 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
48 <hr />
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <a NAME="HelpTopicDialog" ID="HelpTopicDialog"></a>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h2>HelpTopicDialog</h2>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
51
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 Class implementing a dialog to select a help topic to display.
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 </p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <h3>Derived from</h3>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 QDialog, Ui_HelpTopicDialog
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Class Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <tr><td>None</td></tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h3>Class Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
63
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr><td>None</td></tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <h3>Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
68
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
70
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Constructor</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
75 <tr>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td><a href="#HelpTopicDialog.link">link</a></td>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <td>Public method to the link of the selected topic.</td>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 </tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <h3>Static Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
81
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <table>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <tr><td>None</td></tr>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
85
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <h4>HelpTopicDialog (Constructor)</h4>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <b>HelpTopicDialog</b>(<i>parent, keyword, links</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
89
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 Constructor
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
92 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
93 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
94
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <dt><i>parent</i></dt>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dd>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 reference to the parent widget (QWidget)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
98 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
99 <dt><i>keyword</i></dt>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dd>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 keyword for the link set (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
102 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
103 <dt><i>links</i></dt>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dd>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 dictionary with help topic as key (string) and
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 URL as value (QUrl)
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
108 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
109 <a NAME="HelpTopicDialog.link" ID="HelpTopicDialog.link"></a>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <h4>HelpTopicDialog.link</h4>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <b>link</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
112
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <p>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 Public method to the link of the selected topic.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
115 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
116 <dl>
7989
a21d673a8f99 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
117 <dt>Return:</dt>
4918
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 <dd>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 URL of the selected topic (QUrl)
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 </dd>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 </dl>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <div align="right"><a href="#top">Up</a></div>
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <hr />
71caf42a13d8 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </body></html>

eric ide

mercurial