|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to select QtHelp documentation sets to be |
|
25 installed. |
|
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="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> |
|
35 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</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="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> |
|
44 <h2>QtHelpDocumentationSelectionDialog</h2> |
|
45 <p> |
|
46 Class implementing a dialog to select QtHelp documentation sets to be |
|
47 installed. |
|
48 </p> |
|
49 <h3>Derived from</h3> |
|
50 QDialog, Ui_QtHelpDocumentationSelectionDialog |
|
51 <h3>Class Attributes</h3> |
|
52 <table> |
|
53 <tr><td>None</td></tr> |
|
54 </table> |
|
55 <h3>Class Methods</h3> |
|
56 <table> |
|
57 <tr><td>None</td></tr> |
|
58 </table> |
|
59 <h3>Methods</h3> |
|
60 <table> |
|
61 <tr> |
|
62 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> |
|
63 <td>Constructor</td> |
|
64 </tr><tr> |
|
65 <td><a href="#QtHelpDocumentationSelectionDialog.getData">getData</a></td> |
|
66 <td>Public method to retrieve the selected help documents.</td> |
|
67 </tr> |
|
68 </table> |
|
69 <h3>Static Methods</h3> |
|
70 <table> |
|
71 <tr><td>None</td></tr> |
|
72 </table> |
|
73 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> |
|
74 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> |
|
75 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, parent=None</i>) |
|
76 <p> |
|
77 Constructor |
|
78 </p><dl> |
|
79 <dt><i>helpDocuments</i> (dict of lists of str)</dt> |
|
80 <dd> |
|
81 dictionary containing the lists of help documents |
|
82 to be shown |
|
83 </dd><dt><i>parent</i> (QWidget)</dt> |
|
84 <dd> |
|
85 reference to the parent widget |
|
86 </dd> |
|
87 </dl><a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> |
|
88 <h4>QtHelpDocumentationSelectionDialog.getData</h4> |
|
89 <b>getData</b>(<i></i>) |
|
90 <p> |
|
91 Public method to retrieve the selected help documents. |
|
92 </p><dl> |
|
93 <dt>Returns:</dt> |
|
94 <dd> |
|
95 list of QtHelp documentation sets to be installed |
|
96 </dd> |
|
97 </dl><dl> |
|
98 <dt>Return Type:</dt> |
|
99 <dd> |
|
100 list of str |
|
101 </dd> |
|
102 </dl> |
|
103 <div align="right"><a href="#top">Up</a></div> |
|
104 <hr /> |
|
105 </body></html> |