src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTopicDialog.html

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.HelpTopicDialog</h1> 9 <h1>eric7.QtHelpInterface.HelpTopicDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to select a help topic to display. 11 Module implementing a dialog to select a help topic to display.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HelpTopicDialog">HelpTopicDialog</a></td> 22 <td><a href="#HelpTopicDialog">HelpTopicDialog</a></td>
25 <td>Class implementing a dialog to select a help topic to display.</td> 23 <td>Class implementing a dialog to select a help topic to display.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HelpTopicDialog" ID="HelpTopicDialog"></a> 34 <a NAME="HelpTopicDialog" ID="HelpTopicDialog"></a>
36 <h2>HelpTopicDialog</h2> 35 <h2>HelpTopicDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to select a help topic to display. 37 Class implementing a dialog to select a help topic to display.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_HelpTopicDialog 41 QDialog, Ui_HelpTopicDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td> 55 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
62 <td><a href="#HelpTopicDialog.document">document</a></td> 59 <td><a href="#HelpTopicDialog.document">document</a></td>
63 <td>Public method to retrieve the selected help topic.</td> 60 <td>Public method to retrieve the selected help topic.</td>
64 </tr> 61 </tr>
65 </table> 62 </table>
63
66 <h3>Static Methods</h3> 64 <h3>Static Methods</h3>
67
68 <table> 65 <table>
69 <tr><td>None</td></tr> 66 <tr><td>None</td></tr>
70 </table> 67 </table>
71 68
69
72 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a> 70 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a>
73 <h4>HelpTopicDialog (Constructor)</h4> 71 <h4>HelpTopicDialog (Constructor)</h4>
74 <b>HelpTopicDialog</b>(<i>parent, helpKeyword, documents</i>) 72 <b>HelpTopicDialog</b>(<i>parent, helpKeyword, documents</i>)
75
76 <p> 73 <p>
77 Constructor 74 Constructor
78 </p> 75 </p>
76
79 <dl> 77 <dl>
80 78
81 <dt><i>parent</i> (QWidget)</dt> 79 <dt><i>parent</i> (QWidget)</dt>
82 <dd> 80 <dd>
83 reference to the parent widget 81 reference to the parent widget
92 </dd> 90 </dd>
93 </dl> 91 </dl>
94 <a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a> 92 <a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a>
95 <h4>HelpTopicDialog.document</h4> 93 <h4>HelpTopicDialog.document</h4>
96 <b>document</b>(<i></i>) 94 <b>document</b>(<i></i>)
97
98 <p> 95 <p>
99 Public method to retrieve the selected help topic. 96 Public method to retrieve the selected help topic.
100 </p> 97 </p>
98
101 <dl> 99 <dl>
102 <dt>Return:</dt> 100 <dt>Return:</dt>
103 <dd> 101 <dd>
104 help document link for the selected help topic 102 help document link for the selected help topic
105 </dd> 103 </dd>

eric ide

mercurial